🧐 Installation

Follow these steps to install and set up the application:

Clone the repository:

git clone "https://github.com/caiquetorres/course-platform.git"

Install the dependencies:

You can use either Yarn or npm to install the project dependencies. Choose one of the following options:

Using Yarn:

yarn install

Using npm:

npm install

😎 Running the application

First, make sure you have created a new .env file. A suggestion is duplicating the .env.example file, located on the root.

To get started, you'll need to set up your database. The Course Platform Backend is designed to work with Postgres, and it provides a convenient docker-compose file to create a simple local database for testing and debugging purposes.

Run the following command to start the database container:

docker compose up -d postgres

If you prefer to use an existing Postgres instance or a different database solution, you can update the database configuration in the .env file located in the project's root directory. Modify the relevant environment variables such as DB_HOST, DB_PORT, DB_USERNAME, DB_PASSWORD, and DB_DATABASE according to your database setup.

Make sure to save the changes in the .env file and restart the application for the new configuration to take effect.

Depending on your package manager preference, you can use either Yarn or npm to start the application. Choose one of the following options:

• Using Yarn:

yarn start

• Using npm:

npm start

The application will start running, and you should see log messages indicating that the server has started successfully.

Once the server is up and running, you can access the application through http://localhost:3000.