Init Project

Author: mmucito

.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+# trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.env.example

@@ -0,0 +1,6 @@
+NODE_ENV=development
+PORT=3000
+JWT_SECRET=bA2xcjpf8y5aSUFsNB2qN5yymUBSs6es3qHoFpGkec75RCeBb8cpKauGefw5qy4
+JWT_EXPIRATION_MINUTES=15
+MONGO_URI=mongodb://mongodb:xxxxx/ewallet-rest-api
+MONGO_URI_TESTS=mongodb://mongodb:xxxxx/ewallet-rest-api

.eslintrc

@@ -0,0 +1,19 @@
+{
+  "rules": {
+    "no-console": 0,
+    "no-underscore-dangle": 0,
+    "no-unused-vars": ["error", { "argsIgnorePattern": "next" }],
+    "no-use-before-define": ["error", { "variables": false }],
+    "no-multi-str": 0
+  },
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 8
+  },
+  "extends": [
+    "airbnb-base"
+  ]
+}

.gitattributes

@@ -0,0 +1,6 @@
+# Convert text file line endings to lf
+* text=auto
+*.js text
+# Denote all files that are truly binary and should not be modified.
+*.mp4 binary
+*.jpg binary

.gitignore

@@ -0,0 +1,43 @@
+# Environment variables
+.env
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Documentation
+docs
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history

.travis.yml

@@ -0,0 +1,30 @@
+language: node_js
+node_js: '8'
+cache: yarn
+
+git:
+  depth: 3
+
+branches:
+  only:
+    - master
+    - /^greenkeeper/.*$/
+
+env:
+  global:
+    - NODE_ENV=test
+    - PORT=3000
+    - JWT_SECRET=bA2xcjpf8y5aSUFsNB2qN5yymUBSs6es3qHoFpGkec75RCeBb8cpKauGefw5qy4
+    - JWT_EXPIRATION_MINUTES=15
+
+script: yarn validate
+
+before_install: yarn global add greenkeeper-lockfile@1
+before_script: greenkeeper-lockfile-update
+after_script: greenkeeper-lockfile-upload
+
+# deploy:
+# - provider: script
+#   script: yarn deploy
+
+after_success: yarn coverage

.vscode/launch.json

@@ -0,0 +1,36 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "nodemon",
+      "runtimeExecutable": "nodemon",
+      "runtimeArgs": [
+        "--inspect"
+      ],
+      "program": "${workspaceRoot}/src/index.js",
+      "restart": true,
+      "port": 9229,
+      "protocol": "inspector",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "node",
+      "runtimeExecutable": "node",
+      "runtimeArgs": [
+        "--inspect"
+      ],
+      "program": "${workspaceRoot}/src/index.js",
+      "restart": true,
+      "port": 9229,
+      "protocol": "inspector",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+    }
+  ],
+  "compounds": []
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "standard.enable": false
+}

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:8-alpine
+
+EXPOSE 3000
+
+ARG NODE_ENV
+ENV NODE_ENV $NODE_ENV
+
+RUN mkdir /app
+WORKDIR /app
+ADD package.json yarn.lock /app/
+RUN yarn --pure-lockfile
+ADD . /app
+
+CMD ["yarn", "docker:start"]

README.md

@@ -0,0 +1,143 @@
+# E-Wallet Rest Api
+Using Node.js, Express and MongoDB
+
+## 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
+
+Clone the repo:
+
+```bash
+git clone https://github.com/mmucito/ewallet-rest-api.git
+cd ewallet-rest-api
+```
+Install yarn:
+
+```bash
+npm install -g yarn
+```
+
+Install dependencies:
+
+```bash
+yarn
+```
+
+Set environment variables:
+
+```bash
+cp .env.example .env
+```
+
+## Running Locally
+
+```bash
+yarn dev
+```
+
+## Running in Production
+
+```bash
+yarn start
+```
+
+## Lint
+
+```bash
+# lint code with ESLint
+yarn lint
+
+# try to fix ESLint errors
+yarn lint:fix
+
+# lint and watch for changes
+yarn lint:watch
+```
+
+## Test
+
+```bash
+# run all tests with Mocha
+yarn test
+
+# run unit tests
+yarn test:unit
+
+# run integration tests
+yarn test:integration
+
+# run all tests and watch for changes
+yarn test:watch
+
+# 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
+This project is licensed under the [MIT License](https://github.com/mmucito/ewallet-rest-api/blob/master/LICENSE)