DEVELOPERS.md

Setting up and running the app on your machine

This document describes how to set up your development environment to run and test Apply-by-AI. It also explains the basic mechanics of using git, node.

• Prerequisite Software
• Getting the Sources
• Installing NPM Modules
• Spinnng up the Database
• Setting up environment variables
• Starting the server

Prerequisite Software

Before you can run and test Apply-by-AI, you must install and configure the following products on your development machine:

• Git and/or the GitHub app (for Mac or Windows); GitHub's Guide to Installing Git is a good source of information.
• Node.js, (version specified in the engines field of package.json) which is used to run a development web server, run tests, and generate distributable files.
• MongoDB which is used as a NoSQL database.

Getting the Sources

Fork and clone the repository:

1. Login to your GitHub account or create one by following the instructions given here.
2. Fork the main repository.
3. Clone your fork of the repository and define an upstream remote pointing back to the Apply-by-AI repository that you forked in the first place.

# Clone your GitHub repository:
git clone git@github.com:<github username>/apply-by-ai.git

# Go to the Apply-by-AI directory:
cd apply-by-ai

# Add the main repository as an upstream remote to your repository:
git remote add upstream https://github.com/und3fined-v01d/apply-by-ai.git

Installing NPM Modules

Next, install the JavaScript modules needed to build and test Angular:

# Install project dependencies (package.json)
npm ci

Spinnng up the Database

Assuming that you already have your MongoDB database installed, spin up the mongo daemon

mongod

Setting up environment variables

You need to set up Google clientId, secret and callback url in order to work with Google login. Ref: https://developers.google.com/identity/protocols/oauth2

cp .env.template .env

Starting the server

npm run dev