Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakemmarsh/expressed-boilerplate
A boilerplate for quickly building APIs on node.js and Express.
https://github.com/jakemmarsh/expressed-boilerplate
Last synced: about 5 hours ago
JSON representation
A boilerplate for quickly building APIs on node.js and Express.
- Host: GitHub
- URL: https://github.com/jakemmarsh/expressed-boilerplate
- Owner: jakemmarsh
- License: mit
- Created: 2015-08-14T22:31:19.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-05T20:11:18.000Z (almost 8 years ago)
- Last Synced: 2024-04-14T18:05:48.839Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 345 KB
- Stars: 59
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# expressed
[](https://travis-ci.org/jakemmarsh/expressed-boilerplate) [](https://david-dm.org/jakemmarsh/expressed-boilerplate) [](https://david-dm.org/jakemmarsh/expressed-boilerplate#info=devDependencies)
A boilerplate for quickly building an API on [node.js](https://nodejs.org/) and [Express](http://expressjs.com/). Includes:
- Authentication via [Passport](http://passportjs.org/)
- Automated testing framework with code coverage results
- Automated documentation
---
### Getting up and running
1. Clone this repo from `https://github.com/jakemmarsh/expressed-boilerplate.git`
2. Run `npm install` from the root directory
3. Run `npm start`
Your API will now be served to `localhost:3000` by default.
**Note:** While developing, `npm run dev` can be used in place of `npm start` to use Supervisor, allowing your server to automatically restart any time a file is changed.
---
### Sample .env file
API credentials, secret keys, etc. should all be stored in `process.env.*`. This boilerplate achieves this through the use of a `.env` file along with the [dotenv](https://github.com/bkeepers/dotenv) library. The file is gitignored to avoid checking any credentials into source control. This boilerplate currently only uses one environment variable, and so the `.env` file looks like this:
```
SECRET='abcefgqwerty123'
```
---
### API Architecture
```
/api (Contains all files relevant to the API and database logic)
/controllers (Contains all route controllers, separated by entity type)
auth.js (Methods related to user authentication)
user.js
index.js (Exports all controllers to be required in the API)
/models (Will contain all database models/schema definitions)
/utils (Contains miscellaneous files used within the API)
passport.js (Initializes Passport authentication)
index.js (Associates endpoints with route controllers)
/__tests__ (Contains tests for the API, organized in the same structure as the /api directory)
helper.js (Runs before any of the tests, defining test libraries and starting the server)
/__coverage__ (gitignored, but contains HTML coverage results automatically generated by running the tests)
/docs (Contains the auto-generated documentation)
server.js (The Express server which loads and serves the API)
```
**Note:** none of the authorization or database logic has been provided. Any places in which code has been omitted or stubbed are marked with `TODO` comments.
---
### Tests and Coverage
All tests are contained within the `/__tests__` directory, arranged in the same structure as the `/api` directory. The `helper.js` file automatically loads the testing libraries [sinon.js](http://sinonjs.org/) and [should.js](https://shouldjs.github.io/), making them available on the global scope for any of your tests. It also loads and starts the server before running your tests.
Tests are written and run using [mocha](https://mochajs.org/). Code coverage is automatically calculated using [Istanbul](https://github.com/gotwarlost/istanbul), which also generates HTML results pages in the `/__coverage__` directory.
**To run your tests, use the command `npm test`.**
---
### Auto-Documentation
Documentation can be auto-generated for your API using [apiDoc](http://apidocjs.com/) if you annotate your controller methods in the correct format. The format and other options can be seen in the apiDocs documentation.
**To generate your docs, use the command `npm run gen-docs`.**
