KITENGE

RESTful API using NodeJS, Express and Mongoose

---

If you find this useful, please don't forget to star ⭐️ the repo, as this will help to promote the project.
Follow me on Twitter and GitHub to keep updated about this project and others.

---

Features

• Really RESTful - It follows the best practices
• User registration API - Using passport
• Password reset API - Sending emails with SendGrid API (optional)
• Listing query strings - q, page, limit, fields etc.
• API docs generator - Using docgen
• Love ♥ - Using maku

Installation

First install using npm (we assume you have pre-installed node.js).

Commands

After you generate your project, these commands are available in package.json.

Clone this github repo in your terminal

$ cd Kitenge-Backend

$ npm install

$ npm run dev # run the API in development mode

$ npm run prod # run the API in production mode

Playing locally

First, you will need to install and run MongoDB in another terminal instance.

$ mongod

Then, run the server in development mode.

$ npm run dev
Express server listening on http://0.0.0.0:3000, in development mode

The API docs can be ound here: Kitengi

TODO

• Support optional phone authentication
• Support optional email confirmation process
• Support Twitter and other social login methods
• Socket.io support

PRs are welcome.

Credits

maku

License

MIT © maku