Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.23 KB

README.md

File metadata and controls

47 lines (35 loc) · 1.23 KB
Raw

WOSCA

This is the official website repository for She Code Africa WOSCA project.

Guidelines for development and to contribute can be found in GUIDELINES.md. Ensure to read this first if you will be contributing

API Documentation

https://documenter.getpostman.com/view/10230743/Tzz7McNf

Tools/Stacks

  1. Node js
  2. Express
  3. MongoDB
  4. Redis
  5. Postman

Setting up your development environment

  1. Clone this repository into your local machine:
git clone https://github.com/she-code-africa/WOSCA-WEBSITE-BE.git
  1. cd into the folder
 cd WOSCA-WEBSITE-BE
  1. Install dependencies from package.json
 npm install

If you run into problems while running npm install, try npm audit fix then run npm install again

  1. Create .env file and fill out the required information
cp .env.example .env
  1. Start the application by running the server script.
e.g npm run server

  1. If you are yet to install MongoDB, install and set it up on your device (see installation guide here ). After successful installation, start the MongoDB service

  2. Install postman to test all endpoints. Visit http://localhost:7000/ to access the server