https://github.com/emilioriosvz/express-boilerplate

🚀 Starter project for a RESTful API in Node with Express & mongoose component-based
https://github.com/emilioriosvz/express-boilerplate

boilerplate component-architecture eslint express jwt-authentication mongodb mongoose nodejs rest-api standard-js template yarn

Last synced: about 3 hours ago
JSON representation

🚀 Starter project for a RESTful API in Node with Express & mongoose component-based

• Host: GitHub
• URL: https://github.com/emilioriosvz/express-boilerplate
• Owner: emilioriosvz
• Created: 2017-01-13T20:42:47.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-22T04:00:59.000Z (almost 2 years ago)
• Last Synced: 2024-03-15T01:40:38.844Z (8 months ago)
• Topics: boilerplate, component-architecture, eslint, express, jwt-authentication, mongodb, mongoose, nodejs, rest-api, standard-js, template, yarn
• Language: JavaScript
• Homepage:
• Size: 148 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Express & mongoose REST API Boilerplate component based

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![Code Climate](https://codeclimate.com/github/emilioriosvz/express-boilerplate/badges/gpa.svg)](https://codeclimate.com/github/emilioriosvz/express-boilerplate)

[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

## Getting Started

Clone the repo:

```sh

git clone [email protected]:emilioriosvz/express-boilerplate.git

cd express-boilerplate

```

Install yarn:

```js

npm install -g yarn

```

Install dependencies:

```sh

yarn

```

## Run the project in docker

Build the image:

```sh

docker build -t /express-boilerplate .

```

If the image was created correctly, you can see it doing:

```js

docker images

```

Run the image:

```sh

docker run -p 3000:3000 -d --name express-boilerplate /express-boilerplate

```

## Features

* Authentication via JsonWebToken

* Secure app via helmet

* Uses [yarn](https://yarnpkg.com) instead of npm

* Uses [StandardJS](https://github.com/feross/standard) as style guide

* Promises via [Bluebird](http://bluebirdjs.com/docs/getting-started.html)

* API parameter validation via [express-validation](https://github.com/ctavan/express-validator) using [Joi](https://github.com/hapijs/joi)

## Todo list

If you like what you see, there are some tasks that would have to be done:

* Add testing

* Add code coverage

* Add eslint

* Add logger

## Contributing

Contributions, questions and comments are all welcome.🤘