Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gkatsanos/missed-connections-server
The backend / API server of the I Saw You application
https://github.com/gkatsanos/missed-connections-server
async docker es6 expressjs mongodb yarn
Last synced: about 1 month ago
JSON representation
The backend / API server of the I Saw You application
- Host: GitHub
- URL: https://github.com/gkatsanos/missed-connections-server
- Owner: gkatsanos
- Created: 2017-11-05T21:25:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T10:02:14.000Z (almost 2 years ago)
- Last Synced: 2024-12-03T01:36:15.642Z (about 1 month ago)
- Topics: async, docker, es6, expressjs, mongodb, yarn
- Language: JavaScript
- Homepage:
- Size: 1.44 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# The Server
[](http://makeapullrequest.com) [](https://travis-ci.org/gkatsanos/boilerplate-server)
[](https://coveralls.io/github/gkatsanos/missed-connections-server?branch=master)
The Server Part of a Vue/Mongo/Express/Node application.
## Features
- No transpilers, just vanilla javascript
- ES2017 latest features like Async/Await
- CORS enabled
- Uses [yarn](https://yarnpkg.com)
- Express + MongoDB ([Mongoose](http://mongoosejs.com/))
- Consistent coding styles with [editorconfig](http://editorconfig.org)
- [Docker](https://www.docker.com/) support
- Load environment variables from .env files with [dotenv](https://github.com/rolodato/dotenv-safe)
- Gzip compression with [compression](https://github.com/expressjs/compression)
- Linting with [eslint](http://eslint.org)
- Tests with [mocha](https://mochajs.org), [chai](http://chaijs.com) and [sinon](http://sinonjs.org)
- Code coverage with [istanbul](https://istanbul.js.org) and [coveralls](https://coveralls.io)
- Git hooks with [husky](https://github.com/typicode/husky)
- Logging with [morgan](https://github.com/expressjs/morgan)
- Authentication and Authorization with [passport](http://passportjs.org)
- API documentation geratorion with [apidoc](http://apidocjs.com)
- Continuous integration support with [travisCI](https://travis-ci.org)
- Monitoring with [pm2](https://github.com/Unitech/pm2)
## Requirements
- [Node v7.6+](https://nodejs.org/en/download/current/) or [Docker](https://www.docker.com/)
- [Yarn](https://yarnpkg.com/en/docs/install)
## Getting Started
Install dependencies:
```bash
yarn
```
Set environment variables:
```bash
cp .env.example .env
```
## Running Locally
```bash
yarn dev
```
## Running in Production
```bash
yarn start
```
## Test
```bash
# run all tests with Mocha
yarn test
# open nyc test coverage reports
yarn coverage
```
## Validate
```bash
# run lint and tests
yarn validate
```
## Logs
```bash
# show logs in production
pm2 logs
```
## Documentation
```bash
# generate and open api documentation
yarn docs
```
## Docker
```bash
# run container locally
yarn docker:dev
or
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
# run container in production
yarn docker:prod
or
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up
# run tests
yarn docker:test
or
docker-compose -f docker-compose.yml -f docker-compose.test.yml up
```
## Deploy
Set your server ip:
```bash
DEPLOY_SERVER=127.0.0.1
```
Replace my Docker username with yours:
```bash
nano deploy.sh
```
Run deploy script:
```bash
yarn deploy
or
sh ./deploy.sh
```
## License
[MIT License](README.md) - [George Katsanos](https://github.com/gkatsanos)