ALURATUBE

Aluratube is a web application that agregates YouTube videos in a timeline screen.

Technology

• Next.JS

• Supabase

Requirements

Minimal requirements follows the list:

• NodeJS 18.12.0

• NPM 8.19.2

• React.JS 18.2.0

• Next.JS 13.0.2

In the development environment, following the Next.JS linting configuration instructions should be sufficient for code format and standardization.

• Eslint

• Prettier

Also, an account on the Supabase online service is necessary as a database access for the application.

Building

A number of packages are required by the application during the building. It is mandatory that a minimal NodeJS javascript runtime environment is available on the building machine. Instructions for installation on a number of operating system are provided in their download site.

# Clone this repository.
git clone "https://github.com/fndaraujo/aluratube.git"

# Enter the cloned repository.
cd aluratube

# Install packages.
npm install

Running

For running the application, there is a series of Next.JS scripts for usage in development and production environments.

# Run the development version.
npm run dev

# Build the optimized production version.
npm run build

# Run the production version.
npm run build
npm run start

Using container environments is done with a previously downloaded Node.JS image. Follow the minimal requirements list for a suitable version of the image to be used.

Podman container

Podman is only available in the GNU/Linux distributions. It is possible to run rootless and daemonless containers.

# Podman does not require root access.
podman run --rm \
     --interactive \
     --tty \
     --name aluratube \
     --mount "type=bind,source=$(pwd)/,target=/usr/src/App/,Z" \
     --workdir "/usr/src/App/" \
     --publish 3000:3000/tcp \
     docker.io/library/node:18.12.0-alpine \
     npm run dev

Docker container

Docker is a daemon that manages container services.

# Docker requires privileged access to run.
sudo docker run --rm \
     --interactive \
     --tty \
     --name aluratube \
     --mount "type=bind,source=$(pwd)/,target=/usr/src/App/,Z" \
     --workdir "/usr/src/App/" \
     --publish 3000:3000 \
     node:18.12.0-alpine \
     npm run dev

License

See LICENSE file.

Authors

See AUTHORS.md file.

Contributors

See AUTHORS.md file.