Easily make restaurant choices

• Table of Contents
• Built Using
• Installation and Configuration
• Running the Application

  • For testing
  • For Development
  • Running with Docker
  • Production

• Configure Environment Variables

• Node.js

  • Typescript
  • express
  • Sequelize
  • Jest

• PostgreSQL

Before Installation, ensure you have node.js and PostgreSQL installed on your device.

• Clone the Repository

git clone [email protected]:fidelisojeah/fueled.git

• Install Dependencies

npm install

• Configure Environment Variables

  • Configure Environment Variables as specified Here

• Setup Database

  • You are required to create database schemas as well as users as specified in the config files

• Migrate Database

  • Using the ORM Sequelize, migrate database designs

npm run migrate

• Seed Database

npm run seed

Documentation is available at: /api-docs

The applications tests are run with jest

npm run test

The application uses nodemon to enable quick reload on changes

npm run start:dev

it is possible to run the application with docker.

Simply have docker installed on your machine.

docker-compose up

• Stop the application docker-compose down
• Open the docker-compose.yml file and uncomment the seed line.
• Comment out the run line
• change restart to never
• Run docker-compose up

** Similar steps to run migrations **

Coming soon

The following Environment variables need to be set and exported for application to function properly

DATABASE_USERNAME= The name of database user
DATABASE_PASSWORD= the password of database user
DATABASE_NAME= The database name
LOGGER_LEVEL=debug