Skip to main content

Running the Application

This section contains instructions for setting up the local environment for application development.

Prerequisites

To start working on the project, ensure you have the following tools installed:

  • Node.js version 20.x or newer: Node.js is a runtime environment for JavaScript that allows you to run code outside of the browser.
  • npm or yarn: Package managers that allow you to manage project dependencies.
  • Docker: A platform for creating, running, and managing containers.

Steps

1. Clone the repository

The first step is to clone the repository with the project source code to your local computer. Execute the following command in the terminal:

git clone https://github.com/chlip1/CreativeDevelopment.git

2. Navigate to the project directory:

After cloning the repository, navigate to the project directory using the following command:

    cd CreativeDevelopment

3. Set up environment variables (see: Environment Variables):

Environment variables are crucial for configuring the application. Copy the sample environment variables file and edit it to customize the settings to your needs:

    cp .env.example .env
nano .env

Open the .env file in a text editor and enter the appropriate values for each variable.

4. Run the application using Docker Compose

The application is started using the following command:

docker-compose up --build

Once the container is running, the application should be available at http://localhost:4200.