https://github.com/paralect/koa-api-starter

A starter kit for building Koa.JS based restful api
https://github.com/paralect/koa-api-starter

paralect-stack

Last synced: 3 months ago
JSON representation

A starter kit for building Koa.JS based restful api

• Host: GitHub
• URL: https://github.com/paralect/koa-api-starter
• Owner: paralect
• Created: 2017-10-23T15:30:44.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2022-04-18T08:34:37.000Z (over 2 years ago)
• Last Synced: 2024-06-18T13:49:23.497Z (5 months ago)
• Topics: paralect-stack
• Language: JavaScript
• Size: 2.43 MB
• Stars: 66
• Watchers: 16
• Forks: 27
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# This repository is no longer maintained. Check [Ship](https://github.com/paralect/ship).

# Koa.JS REST api starter 

[![Stack](https://raw.githubusercontent.com/paralect/stack/master/stack-component-template/stack.png)](https://github.com/paralect/stack)

Fully featured [Koa.JS](http://koajs.com/) 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](https://www.npmjs.com/package/@paralect/common-logger)

3. Automatic application restart when code changes with [Nodemon](https://github.com/remy/nodemon)

4. MongoDB configuration

5. Docker configuration for development and production environments.

6. Code linting based on [paralect/eslint-config](https://github.com/paralect/eslint-config)

7. Simplified request data validation and clean up based on [joi](https://github.com/hapijs/joi) and [koa-validate](https://www.npmjs.com/package/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](https://console.developers.google.com/apis/) 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`:

```bash

$ ./bin/start.sh

```

To start the project not in the docker container just run: `npm run dev`. 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](./src/config) - consist of configuration for the [environment](./src/config/index.js), [koa server](./src/config/koa.js) and [API routes](./src/config/routes).

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

    - [middlewares](./src/config/routes/middlewares) - koa middlewares which we use on every request (for example, get current user data from the database)

3. [src/resources](./src/resources) - REST api resources and everything related to the resource:

    - [database service](./src/resources/user/user.service.js) - resource service to work with database (MongoDB or other database)

    - [database schema](./src/resources/user/user.schema.js) - database schema for the resource entity.

    - [validators](./src/resources/account/validators/signup.validator.js) - request validation logic. You can use this validators inside of the validation middleware ([example in ./src/resources/account/public.js](./src/resources/account/public.js)) or you can use this validators inside of the controller ([example in ./src/resources/user/user.controller.js](./src/resources/user/user.controller.js))

    - [controllers](./src/resources/account/account.controller.js) - the central place for the request handling and data manipulation.

    - [builders](./src/resource/user/user.builder.js) - creating database documents for testing.

    - [factory](./src/resource/user/user.factory.js) - predefined types of database documents for testing.

    - [tests](./src/resource/user/user.spec.js) - mocha tests for the endpoint.

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

    - [src/services/email.service.js](./src/services/email.service.js) - fake service for sending application emails.

    - [src/services/socket.io.service.js](./src/services/socket.io.service.js) - service to work with sockets.

    - [src/auth.service.js](./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](./src/app.constants.js) - constant variables that are used in the application

2. [src/app.js](./src/app.js) - starting point of the node.js application. It combine application configuration and start Koa http listener.

3. [src/db.js](./src/db.js) - handles connection to the MongoDB.

4. [src/logger.js](./src/logger.js) - application logger.

5. [src/security.util.js](./src/security.util.js) - number of methods for generating secure tokens and comparing passwords with password hash.