Renec - Video Sharing

This is a video sharing platform, where users can share videos from youtube platform.

Introduction

This project is a video sharing platform where users can share YouTube videos with everyone. The key features of the project include:

Register and login functionality
Share videos by inputting the YouTube URL
Users can view shared videos and provide thumbs-up or thumbs-down ratings

Prerequisites

Environment Setup

Before getting started with the project, ensure you have the following software and tools installed:

Node.js v16 or higher
Yarn package manager
MongoDB database
Lerna and Nx
Docker and Docker Compose

Database Setup

How to install MongoDB using docker compose

Create a docker-compose.yml file in your project directory and add the following content:

version: '3'
services:
  mongo:
    image: mongo
    restart: always
    ports:
      - 27017:27017
    environment:
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: root123

In this configuration, we're using the official MongoDB Docker image, exposing port 27017, and setting the root username and password. Make sure to change the password to a secure value in a production environment.

Run the following command to start the MongoDB container:

docker-compose up -d

This will download the MongoDB image (if not already present) and start the container in the background.

Once the MongoDB container is running, execute the following command to create a user and database:

docker exec -it <container_name> mongo admin -u root -p example --eval "db.createUser({ user: 'your_username', pwd: 'your_password', roles: [{ role: 'readWrite', db: 'your_database' }] })"

Replace <container_name> with the name or ID of your MongoDB container. Also, update your_username, your_password, and your_database with your desired values.

For example:

docker exec -it my-mongodb-container mongo admin -u root -p example --eval "db.createUser({ user: 'renec', pwd: 'renec_123', roles: [{ role: 'readWrite', db: 'renec_db' }] })"

This command will connect to the MongoDB container, authenticate as the root user, and create a new user with read-write access to the specified database.

You can now use the created user and database credentials in your project's configuration to connect to the MongoDB instance.

P/S: Remember to update the credentials in your project's configuration files to match the ones you specified during the user and database creation step.

Monorepo Setup with Lerna and Nx

This project is organized as a monorepo using Lerna and Nx. A monorepo allows you to manage multiple related projects in a single repository. Lerna is a tool for managing JavaScript projects with multiple packages, while Nx is a set of extensible dev tools for monorepo development.

To learn more about monorepos, Lerna, and Nx, you can refer to the following resources:

Beside that, you can discovery my library for monorepo development at: JokTec Monorepo

Getting Started

Installation & Configuration

To get the project up and running on your local machine, follow these steps:

Clone the repository:

git clone https://github.com/username/project.git

Install project dependencies:

yarn install

Setup environment variables:

Open file apps/renec-api/config.yml and edit your MongoDB connection

mongo:
  host: localhost
  port: 27017
  username: renec
  password: renec123
  database: renec_db
  connectTimeout: 20000
  directConnection: true

Go to directory /apps/renec-web and create a file .env, then add the following content:

WEB_URL=https://localhost:3000
API_URL=https://localhost:9010

Running the Project

In this project structure, you will see 2 packages in apps directory:

renec-api: This is the backend API server develop with NestJS
renec-web: This is the frontend web application develop with NextJS

All of packages are using Lerna and Nx to manage workspace, so you can run the following command to start the project:

yarn dev --scope @renec/api
yarn dev --scope @renec/web

Explaining the command:

Each packages have a package.json file, and have a name with format @renec/<package_name>
In the root of package.json file, there is a script with name dev, this script will run the command yarn dev as parallel for any packages have the same name script
You can also specify the package name to run the command, for example: yarn dev --scope @renec/api
You can do a similar thing with other scripts, for example: yarn build --scope @renec/api

Testing

Unit Test

To run unit tests, you can use the following command:

yarn test --scope @renec/api

Test coverage

To run test coverage, you can use the following command:

yarn test:cov --scope @renec/api

Integration Test

TBD

E2E Test

TBD

Usage

After running the project, you can access the web application at https://localhost:3000

You can also access the API documentation at https://localhost:9010/swagger

Once the application is up and running, you can use it as follows:

Register a new account or log in with existing credentials.
Share a video by entering the YouTube URL.
Other users can view the shared video and provide thumbs-up or thumbs-down ratings.

Note: You can check the production release at:

Web application: https://joktec.com/
API documentation: https://api.joktec.com/swagger

Deployment

Manual Deployment (Using PM2 and Nginx)

Build the project:

yarn build

Deploy the project into VM (maybe using SFPT or Rsync)
Install PM2 and Nginx
Start project with PM2

pm2 start apps/renec-api/dist/main.js --name renec-api
pm2 start yarn --name renec-web -- serve

Configure Nginx with proxy_pass to the project

server {
    listen 80;
    server_name api.joktec.com;

    location / {
        proxy_pass http://localhost:9010;
    }
}

Docker Deployment (Kubernetes)

(Note: This section is under development and will be updated in the future. Please refer to the project documentation or consult with the development team for the latest instructions on deploying the application using Docker.)

Deploying the application using Docker provides a convenient way to package and distribute your project as a containerized application. Docker allows for consistent deployment across different environments, making it easier to manage dependencies and ensure reproducibility.

To deploy the application using Docker, follow the instructions provided in the project documentation or consult with the development team for the specific steps. This section will be updated in the future to provide detailed instructions on building the Docker image and running containers.

In the meantime, you can explore Docker's official documentation to familiarize yourself with Docker concepts and commands:

Docker Overview

Please refer to the project's future updates or documentation for the complete Docker deployment guide.

Troubleshooting

If you encounter any issues during the setup or usage of the project, refer to the following troubleshooting steps:

Ensure that you have installed all the required software and tools.
Ensure that you have configured the project correctly.
Ensure that you have started the MongoDB container.
Ensure that you have started the project with the correct command.
Ensure that you have specified the correct URLs in the web application's .env file.
Ensure that you have specified the correct MongoDB credentials in the API server's config.yml file.

Technical Debt

There are some technical debt in this project, and I will try to fix it in the future:

trangiabao1203 / renec-app