LearnerLinkup is a web application designed to streamline the student enrollment process.

Before you can launch the LearnerLinkup project, ensure the following software is installed on your system:

• Node.js (version 18 or later)
• For database management, either Docker or a local installation of PostgreSQL can be used.

Follow these steps to set up the LearnerLinkup project on your machine:

First, clone the repository to your local machine. You can use either SSH or HTTPS:

# SSH
git clone [email protected]:lucasbeckps/learner-linkup.git

# HTTPS
git clone https://github.com/lucasbeckps/learner-linkup.git

If Corepack is not already enabled on your system, you can activate it by running the following command as root or using sudo:

sudo corepack enable

Corepack allows you to manage your Node.js package managers and ensures that you use the package manager version specified in the 'package.json' file.

Navigate to the project's root directory where the package.json is located and run the following command to install all required dependencies for the packages within the monorepo:

yarn install

Duplicate the .env.example file and rename the copy to .env.

cp .env.example .env

By default, LearnerLinkup is configured to use a PostgreSQL database within a Docker container. Should you prefer utilizing a local PostgreSQL database, adjust the environment variables in the .env file accordingly.

• For Docker users: Execute docker compose up --build to build and start the postgresql database container.
• For local PostgreSQL users: Ensure your PostgreSQL database service is active.

Execute yarn migrate to apply database migrations and create necessary tables.
If desired, you can set the project seed the database with preliminary data initially. These settings can be modified in the migrations-config.js file. With this initial setup, the default login credentials will be [email protected] with the password Password123*.

Once the installation and setup processes are complete, the application is ready to be launched.

• Start the project by running yarn dev. This command initiates both the API and the frontend server.
• Access the frontend interface at https://localhost:3001.