dzinrai / koa-api-starter

A starter kit for building Koa.JS based restful api

Koa.JS REST api starter

Fully featured Koa.JS restful api starter application. The goal of this project is to solve all routine tasks and keep your focus on the product and business logic of the application, not on the common things, such logging, configuration, dev/production environments

Out of the box support following features:

1. Config management.
2. Configured console logger based on common-logger
3. Automatic application restart when code changes with Nodemon
4. MongoDB configuration
5. Docker configuration for development and production environments.
6. Code linting based on paralect/eslint-config
7. Simplified request data validation and clean up based on joi and koa-validate
8. Production ready account API resource (singup, signin, forgot password, reset password functionality)
9. Access token based authentication.
10. Tests for endpoints.
11. WebSocket server (socket.io)
12. Database migrations
13. Scheduler

Prerequisites

Google authorization

Fill data from google in src/config/environment/index.js

google: {
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  redirectUri: 'redirectUri',
}

Start

In order to start server in the docker container you can use bash file ./bin/start.sh:

$ ./bin/start.sh

To start the project not in the docker container just run: npm run development. This command will start the application on port 3001 and will automatically restart whenever you change any file in ./src directory.

Explanations of the files structure

We try to keep things as simple as possible, so you can focus on building product instead of learning concepts.

There are three main directories within project:

1. src/config - consist of configuration for the environment, koa server and API routes.

2. src/config/routes - consist of public (don't require access token) and authenticated (require access token) routes and middlewares.

   • middlewares - koa middlewares which we use on every request (for example, get current user data from the database)

3. src/resources - REST api resources and everything related to the resource:

   • database service - resource service to work with database (MongoDB or other database)
   • database schema - database schema for the resource entity.
   • validators - request validation logic. You can use this validators inside of the validation middleware (example in ./src/resources/account/public.js) or you can use this validators inside of the controller (example in ./src/resources/user/user.controller.js)
   • controllers - the central place for the request handling and data manipulation.
   • builders - creating database documents for testing.
   • factory - predefined types of database documents for testing.
   • tests - mocha tests for the endpoint.

4. src/services - application services for various purposes. Not this directory contains the following services:

   • src/services/email.service.js - fake service for sending application emails.
   • src/services/socket.io.service.js - service to work with sockets.
   • src/auth.service.js - token based authentication helper

All other files, that does not fit that structure should be placed straight in the src folder. We can always introduce more folders as we need them. Currently root folder consist following:

1. src/app.constants.js - constant variables that are used in the application
2. src/app.js - starting point of the node.js application. It combine application configuration and start Koa http listener.
3. src/db.js - handles connection to the MongoDB.
4. src/logger.js - application logger.
5. src/security.util.js - number of methods for generating secure tokens and comparing passwords with password hash.

List of improvements

1. Implement email service.

License

Koa.JS REST api starter is released under the MIT License.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Join us and share something developers need 👌.

Contributors

Thanks goes to these wonderful people (emoji key):

Evgeny Zhivitsa 💻 📖 🤔 👀 ⚠️	Andrew Orsich 📖 🤔 👀	Ihar 💻 🤔	KuhArt 💻	NesterenkoNikita 💻 👀 🤔 ⚠️	Nikita Solosnuk 💻 👀 🤔	Mar1nka 💻 🤔
Kirill Scherbenok 💻 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!