/Kaybook-API

RESTful API that supports e-commerce, posts, forums, polls, chats groups, DMs and more

Primary LanguageJavaScriptMIT LicenseMIT

Kaybook-API

KayBook is a RESTful API with 77 routes that can be used for e-commerce, posts, forums, polls, chat groups, dms and much more.

Environment

Make sure you are running Node.js and have connection to a Mongo Database

Installing

  1. Clone the repo by running git clone https://github.com/khalidM3/Kaybook-API
  2. Install dependacies by running npm install or yarn install
  3. Add a .env file with the following content, make sure to switch the placeholders with your values.
    PORT= <PORT>
    SECRET= <SECRET>
    MONGODB_URI= <MONGODB_UR>
    CORS_ORIGINS='localhost:8080'
    AWS_BUCKET= <AWS BUCKET>
    AWS_ACCESS_KEY_ID= <AWS_ACCESS_KEY_ID>
    AWS_SECRET_ACCESS_KEY= <AWS_SECRET_ACCESS_KEY>
  1. Run npm start to start server

Routes

All the routes are found in ./src/router. I couldn't write docs for all 77 of them, so i made the code is extreamly readable. Check it out

NOTE

  • This project is not being maintained by me, but PR are always welcome.
  • ES6 imports are not native to Node.js (as of now), this project is using babel, which transpiles es6 imports to CommonJS.