Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imbudhiraja/express-boilerplate
ExpressJS boilerplate with Socket.IO, Mongoose for scalable projects.
https://github.com/imbudhiraja/express-boilerplate
api-docs backend-services boilerplate express express-boilerplate express-js expressjs javascript json mongoose node node-js nodejs rest-api socket socket-io
Last synced: 30 days ago
JSON representation
ExpressJS boilerplate with Socket.IO, Mongoose for scalable projects.
- Host: GitHub
- URL: https://github.com/imbudhiraja/express-boilerplate
- Owner: imbudhiraja
- License: mit
- Created: 2019-03-19T06:36:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T18:43:33.000Z (over 1 year ago)
- Last Synced: 2024-09-27T18:40:53.016Z (about 1 month ago)
- Topics: api-docs, backend-services, boilerplate, express, express-boilerplate, express-js, expressjs, javascript, json, mongoose, node, node-js, nodejs, rest-api, socket, socket-io
- Language: JavaScript
- Homepage:
- Size: 1.89 MB
- Stars: 94
- Watchers: 4
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Express Boilerplate
ExpressJS boilerplate with Socket.IO, Mongoose for scalable projects.
### Includes
- [ExpressJS](https://expressjs.com)
- [NodeJS](https://nodejs.org/en/)
- [Mongoose](http://mongoosejs.com/docs/guide.html)
- [Socket.io](https://socket.io/docs)
- [Nodemon](https://nodemon.io/)
- [API-Docs](http://apidocjs.com)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
```bash
#!/bin/bash
[email protected] or higher
```
### Installing
A step by step series that will tell you how to get a development env running
```bash
#!/bin/bash
$ git clone https://github.com/imbudhiraja/express-boilerplate.git
$ cd express-boilerplate
```
```node
#!/.nvm/versions/node/v10.x.x/bin/node
$ npm ci
```
### Useful Scripts
| Script | Description |
| ------ | ------ |
| npm run dev | Starts development server at localhost:8443 and socket server at localhost:3002 |
| npm start | Starts production server at localhost:8443 and socket server at localhost:3002 |
| npm run lint | Run Eslint to find out linting issues. |
| npm run docs | Create API docs. checkout APIs at - localhost:3001/v1/docs |
| npm run docs-postman | Create API docs [JSON](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON) file to import to [Postman](https://www.getpostman.com) |
### Run at local server
```bash
touch .env
npm run start
http://localhost:8443/
```
#### NOTE - Refer to [Sample Env](https://github.com/imbudhiraja/express-boilerplate/blob/master/sample-env.js) File
### Check Server Status
Once server has started run http://localhost:8443/healthcheck.
## [Issues](https://github.com/imbudhiraja/express-boilerplate.git/issues)
### [LICENSE](https://github.com/imbudhiraja/express-boilerplate/blob/master/LICENSE)