A service for an automated system to help Andela perform on-boarding and off-boarding processes for fellows joining or leaving engagements.

• Node.js
• Express
• PostgreSQL DB

The following should be installed in your machine

• Node v10.8.0
• PostgreSQL v9+

• Clone this Repo and cd into it
• Install all the dependancies by running the npm install command (or yarn install if you prefer)
• Create a .env file and use .env.example as a guide on the environment variables required
• Run npm run migrations to setup the database tables.
• Start the application by running the npm start command(npm start:dev for 'watch' mode. You can also use yarn if you prefer)

• To run tests use the npm test command.

• Install docker
• stop the local instances of postgres and redis. In macos, this is achieved by:
  • brew services stop redis
  • brew services stop postgres

On the terminal run the following commands:

1. Change to the application root directory

2. Uncomment this line for local development. Change the following Environment Variable:

   REDIS_HOST=redis

3. Build a docker image with the following command docker build -t esa-backend .

4. Use docker compose to install services required by the application i.e postgres and redis

5. Then run docker-compose up

• To access the database and view records
  • open http://localhost:8080 in your browser and login using the following credentials
    • System as postgreSQL,
    • Server as database,
    • Username as postgres,
    • Password as postgres
    • database as esa_dev

• API documentation is a concise reference manual containing all the information required to work with the API, with details about the functions, classes, return types, arguments and more, supported by tutorials and examples. We take API Documentation Seriously.

The documentation can be viewed on this link.

Issues are always very welcome. Please be sure to follow the issue template.

We're glad to get pull request if anything is missing or something is buggy. However, there are a couple of things you can do to make life easier for the maintainers:

• Explain the issue that your PR is solving - or link to an existing issue
• Follow the repository structure, and new sections in the corresponding folders

Git Conventions Make sure you adhere to our convention for your commits and PR.