Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xiaofan2406/restful-api-server

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/xiaofan2406/restful-api-server
Owner: xiaofan2406
Created: 2016-05-12T06:57:50.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-11-28T04:45:13.000Z (about 3 years ago)
Last Synced: 2024-04-12T07:02:39.973Z (10 months ago)
Language: JavaScript
Size: 149 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # MOVED to bitbucket!!!

# REST-ful API server

[Node v6](https://nodejs.org/api/) + [Express](http://expressjs.com/) + [Sequelize](http://docs.sequelizejs.com/en/latest/) + [PostgreSQL](http://www.postgresql.org/docs/9.5/static/index.html)

# Get Started

* `npm run setup`

* modify `-config.js` files under `config/` directory

* define models

* define routes

* `npm test`

* `npm start`

# TODOs

* **HTTP status code**

* **Documentation**

* promisify callbacks

* ~~email log~~

* testing

* view engine setup

* express middleware config

* ~~user authentication~~

* sequelize database migrations

* production setup

* folder structure

* ~~webpack es6 babel~~

> remove sequelize in the futuer, use pg, and es6 classes

# Conventions

### Nodejs Naming

| Target      | Type       |

| ----------- | ---------- |

| Directories | kebab-case |

| Files       | kebab-case |

| Classes     | PascalCase |

| Models      | PascalCase |

| Variables   | camelcase  |

### Database Naming

| Target      | Type       |

| ----------- | ---------- |

| Name        | snake_case |

| Table name  | snake_case |

| Attribute   | camalCase  |