chiazokam / floof

Floof

FLOOF

Documentation

Postman

Deployed URL

Floof API

Tools Used

• Express
• Sequelize
• PostgreSQL
• Winston and Morgan
• Redis
• Babel for transpiling

Local Setup

• Clone repo and name your folder using git clone https://github.com/Chiazokam/floof.git [folder name]

• cd into cloned folder using: cd [folder name]

• Set up redis locally. Check out redis docs for how to set up locally.

• Set up postgres locally in order to get the database name, host and password. Check out their docs here on setting up postgres

• Create a .env file at the root of the folder and populate it taking queue from the .env.example file

• Run npm install to install all dependencies

• Run the following scripts to migrate and seed the database respectively:

  • npm run run:db
  • npm run seed

• Now, youre set to run the app. Run the app using npm start:dev

• You are good to go!