node-rest-api-boilerplate - GitLite

KO | EN

gitlite — search

#python #react #ai #typescript #llm #machine-learning #deep-learning #nodejs #macos #windows #pytorch #mcp #ios #openai

node-rest-api-boilerplate

(★ 105)

ES6 Node Rest API boilerplate with Mongo Datastore

File Explorer

Download Latest Version (.zip)

- - constants.js
- - auth.controller.js
  - base.controller.js
  - meta.controller.js
  - posts.controller.js
  - users.controller.js
- - util.js
- - access-control.js
  - authenticate.js
  - error-handler.js
- - post.js
  - user.js
- database.js
- index.js
- routes.js
- server.js
- - post.factory.js
  - user.factory.js
- - post.model.spec.js
  - user.model.spec.js
- - base.route.spec.js
- - server.mock.js
.babelrc
.eslintignore
.eslintrc
.gitignore
.travis.yml
History.md
index.js
LICENSE
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/kylealwyn/node-rest-api-boilerplate

Downloads the entire project code from GitHub to your computer.

cd node-rest-api-boilerplate

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Express & ES6 API Boilerplate
[![Build Status](https://travis-ci.org/kylealwyn/node-rest-api-boilerplate.svg?branch=master)](https://travis-ci.org/kylealwyn/node-rest-api-boilerplate)
> Tested on Node v6 and above

## Features
- [x] ES6 for the latest & greatest javascript awesomeness
- [x] [MongoDB](https://www.mongodb.com/) w/ [Mongoose](http://mongoosejs.com/) for data layer
- [x] Testing via [Mocha](https://mochajs.org/) & [Chai](http://chaijs.com/)
- [x] Test coverage via [Isparta](https://github.com/douglasduteil/isparta)
- [x] Username/Email registration and authentication

## Getting Started
First, ensure you have node and mongo installed on your system.

```sh
# clone it
git clone git@github.com:kylealwyn/node-rest-api-boilerplate.git
cd node-rest-api-boilerplate

# Make it your own
rm -rf .git && git init

# Install dependencies
npm install

# Run it
npm start

# Try it!
curl -H "Content-Type: application/json" -X POST -d '{"username":"jamesdean", "email": "example@gmail.com", "password":"password1"}' http://localhost:4567/users
```

## Environment Variables
Place a `.env` file in the top level of the directory you've cloned. These variables will be automatically assigned to `process.env` when the application boots. It is gitignored by default as it's not good practice to store your environment variables in your remote repository.
Your `.env` file can look something like this:

```shell
MONGO_URI=mongodb://somewhere:27017
SESSION_SECRET=lolthisissecret
```

Now we can access one of these variables with something like `process.env.MONGO_URI`!

## NPM Scripts

- **`npm start`** - Start live-reloading development server
- **`npm test`** - Run test suite
- **`npm run test:watch`** - Run test suite with auto-reloading
- **`npm run coverage`** - Generate test coverage
- **`npm run build`** - Generate production ready application in `./build`

## Todo
- [ ] Add OAuth Login Support (Facebook, Twitter, Google)
- [ ] Add support for MySql or PostgreSQL (Possibly with sequelize)
- [ ] Reset password functionality

## License
MIT