matthoiland / node-rest-api

NodeJS API starter project

NodeJS API Starter

Stop being dumb and start being smart.

Tools and Practices Used

• w/
• w/
• 
• w/(-ish) responses
• for resource events
• acceptance testing
• 
• 
• 
• event logging

Setup

Prerequisites

Make sure that Node, Mongo, and Redis are installed on your machine. If not, install these with .

brew install node
brew install mongodb
brew services start mongodb
brew install redis
brew services start redis
redis-cli ping

Environment Config File

Create a file called .env in the root directory. This is just for local development – in production you'll set these as environment variables on your server.

SECRET=secret-string-for-tokens-and-encryption
EXAMPLE_CLIENT_ID=123456ab-cdef-ghij-klmn-opqrstuvwxyz
EXAMPLE_CLIENT_SECRET=123456ab-cdef-ghij-klmn-opqrstuvwxyz
BASE_URL=
MONGODB_URI=
REDIS_URL=

Run

# Install dependencies
npm install

# Development
npm run dev

# Production
npm start

Rules of Thumb

Writing Code

• Write clean, but not clever code
• Write comments for a level II dev
• Avoid premature optimization

Error Codes

Keep the status codes simple - try to stick to these.

• 200 – OK
• 201 – Created
• 204 – No Content
• 304 – Not Modified
• 400 – Bad Request
• 401 – Unauthorized
• 403 – Forbidden
• 404 – Not Found
• 410 – Gone
• 500 – Internal Server Error