Name: node-express-realworld-example-app
Owner: Thinkster
Description: null
Created: 2016-07-15 09:41:40.0
Updated: 2018-01-18 19:03:23.0
Pushed: 2018-01-07 04:59:27.0
Homepage: null
Size: 80
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Example Node (Express + Mongoose) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld API spec.
This repo is functionality complete ? PRs and issues welcome!
To get the Node server running locally:
npm install
to install all required dependenciesmongod
npm run dev
to start the local serverAlternately, to quickly try out this repo in the cloud, you can
mongoose-unique-validator
plugin helps us by formatting the error like a normal mongoose ValidationError
.app.js
- The entry point to our application. This file defines our express server and connects it to MongoDB using mongoose. It also requires the routes and models we'll be using in the application.config/
- This folder contains configuration for passport as well as a central location for configuration/environment variables.routes/
- This folder contains the route definitions for our API.models/
- This folder contains the schema definitions for our Mongoose models.In routes/api/index.js
, we define a error-handling middleware for handling Mongoose's ValidationError
. This middleware will respond with a 422 status code and format the response to have error messages the clients can understand
Requests are authenticated using the Authorization
header with a valid JWT. We define two express middlewares in routes/auth.js
that can be used to authenticate requests. The required
middleware configures the express-jwt
middleware using our application's secret and will return a 401 status code if the request cannot be authenticated. The payload of the JWT can then be accessed from req.payload
in the endpoint. The optional
middleware configures the express-jwt
in the same way as required
, but will not return a 401 status code if the request cannot be authenticated.