Merge pull request #170 from Human-Connection/develop

Update master

Author: roschaefer

.gitignore

@@ -34,6 +34,7 @@ node_modules
 .classpath
 .c9/
 .vscode
+/.vs
 *.launch
 .settings/
 *.sublime-workspace
@@ -123,3 +124,4 @@ rethinkdb_data
 .env
 /config/local.json
 package-lock.json
+/.github

.travis.yml

@@ -21,10 +21,8 @@ jobs:
       - docker build -t humanconnection/api-feathers .
     - script:
       - yarn install --frozen-lockfile --non-interactive
-      - yarn add codacy-coverage
-      - yarn run eslint
-      - cp config/cucumber.json config/local.json
-      - yarn run test:coverage
+      - yarn global add codacy-coverage
+      - yarn run ci
       - cat ./coverage/lcov.info | codacy-coverage
 
 after_success:

Dockerfile

@@ -1,36 +1,35 @@
-FROM node:8.9-alpine
+FROM node:alpine
 LABEL Description="This image is used to start the hc-api-feathers" Vendor="Human-Connection gGmbH" Version="1.0" Maintainer="Human-Connection gGmbH ([email protected])"
 
-# update unix packages
-RUN apk update && apk upgrade
-RUN rm -rf /var/cache/apk/*
-RUN yarn global add pm2
-
 # expose the app port
 EXPOSE 3030
 
-# set environment variables
-# ENV NPM_CONFIG_PRODUCTION=false
-# ENV HOST=0.0.0.0
+# override configuration by instance name in docker container
+ENV NODE_APP_INSTANCE=docker
 ENV NODE_ENV=production
-ENV API_PORT=3030
-
-# start the application in a autohealing cluster
-# NOTE: quick fix for server issues, restart api when reaching max of 300 MB Memory Usage (happens in conjunction with 100% CPU Usage)
-# TODO: find better way of dealing with that issue
-CMD NODE_ENV=production pm2 start server/index.js -n api --attach --max-memory-restart 1024M
-# CMD NODE_ENV=production pm2 start server/index.js -n api -i 2 --attach
-# as we have issues with pm2 currently in conjunction with nuxt, we use the standard approach here
-# CMD NODE_ENV=production node server/index.js
 
 # create working directory
-RUN mkdir -p /var/www/
-WORKDIR /var/www/
+RUN mkdir -p /API
+WORKDIR /API
+
+# --no-cache: download package index on-the-fly, no need to cleanup afterwards
+# --virtual: bundle packages, remove whole bundle at once, when done
+RUN apk --no-cache --virtual build-dependencies add python make g++
+
+RUN yarn global add pm2
 
 # install app dependencies
-COPY package.json /var/www/
-COPY yarn.lock /var/www/
-RUN yarn install --frozen-lockfile --non-interactive
+COPY package.json /API
+COPY yarn.lock /API
+RUN yarn install --production=false --frozen-lockfile --non-interactive
+
+RUN apk del build-dependencies
+
 
 # copy the code to the docker image
-COPY . /var/www/
+COPY . /API
+
+# start the application in a autohealing cluster
+# NOTE: quick fix for server issues, restart api when reaching max of 300 MB Memory Usage (happens in conjunction with 100% CPU Usage)
+# TODO: find better way of dealing with that issue
+CMD ["pm2", "start", "server/index.js", "-n", "api", "--attach", "--max-memory-restart", "1024M"]

README.md

@@ -12,125 +12,13 @@
 </p>
 
 # Human-Connection API
-
-The API for a better world. More information under [human-connection.org](https://human-connection.org)
-
-> **Note:** This is only the API part of Human-Connection, you have to also checkout the [WebApp](https://github.com/Human-Connection/WebApp) which uses this API.
-
-## Development
-
-> we recommand to install the project locally for the best development ease and performance
-
-Getting up and running is as easy as 1, 2, 3, 4 ... 5.
-
-1. Make sure you have [NodeJS](https://nodejs.org/), [yarn](https://yarnpkg.com), [mongoDB](https://www.mongodb.com/download-center#community) installed.
-
-2. Clone this repo
-   ``` bash
-   $ git clone https://github.com/Human-Connection/API.git
-   ```
-
-3. Install your dependencies
-   ``` bash
-   $ cd ./API
-   $ yarn
-   ```
-
-4. Setup local mailserver (optional)
-   
-   >  **Note:** 
-   >  *You only have to start that mailserver when you want to register, reset your password or test emails in any form, it
-   >  does not affect the rest of the application.*
-        
-   Copy `config/local.example.json` to `config/local.json` and install the [MailDev](https://github.com/djfarrelly/MailDev)
-   server to catch all sent emails in a nice web interface.
-    
-   ``` bash
-   # install mail dev (only has to be done once)
-   $ npm install -g maildev
-   
-   # start the server, it will output the web url 
-   # which normally is http://localhost:1080
-   $ maildev
-   ```
-   
-   You could also insert your smtp credentials into the local.json but that is not recommended as all emails would be sent
-   to the given addresses which should not happen in development.
-   
-5. Start server
-
-   Make sure that the `data` folder exists according to the `mongod --dbpath` in `package.json` to write the data into, then start the server:
-   ``` bash
-   # start mongodb, feathers and seed database
-   $ yarn dev
-   $ yarn dev:win if you're on windows
-
-   # start mongodb, feathers without seeding the database
-   $ yarn dev:noseed
-   
-   # start mongodb, feathers for production
-   $ yarn start
-   ```
-
-   > ##### IMPORTANT for WIN users: 
-   > - make sure you have mongo bin directory added to your PATH
-   > - if you picked another data directory during mongodb setup make sure 
-   > to change package.json scripts section for key "dev:win" so it points to
-   > the proper path. Otherwise you will get missing data path errors from mongodb.
-   
-   If you did it right it will seed some fake data for you and downloads some images and avatar for faster development.
-   Now you should be able to list some post at [http://localhost:3030/contributions](http://localhost:3030/contributions)
-
-6. Setup and Start Thumbnail Service (optional)
-
-   We are using [Thumbor](https://github.com/thumbor/thumbor) as a Thumbnail Microservice.
-   You can install it locally if you like but this is totally optional.
-   
-   **Install OR use docker**
-   
-   - At first you have to [install](http://thumbor.readthedocs.io/en/latest/installing.html) it locally and start it in the console with `thumbor` **OR** run it with docker `docker run -p 8000:8000 apsl/thumbor`
-   - Set the `thumbor.url` in `config/local.json` to `http://localhost:8888` (with docker `http://localhost:8000`) if not defined differently. The `thumbor.key` does not necessarily have to be defined, it just makes the URL more secure.
-   
-   > Do not forget to always start it if you choose that setup or otherwise you will not see any pictures at all.
-
-## Local configuration
-
-If you need to configure anything you can do so inside the `config/local.json` file. For that the `config/local.example.json` will contain always a minimal setup to get it working.
-
-If, f.ex., you want to change listen address, port or URL, you can do so. Entries in the `config/local.json` will override entries in the `config/default.json`.
-
-**Note on the seeder configuration**
-The seeder configuration has two properties:
-- **dropDatabase:** drop the whole database on (re)start.
-- **runOnInit:** run the seeder always on server (re)start (when database is empty).
-
-> **Note** *You can switch the `dropDatabase` entry after seeding and it will persist the seeded data.* 
-
-## Testing
-
-Simply run `yarn test` and all your tests in the `test/` directory will be run.
-
-## Scaffolding
-
-Feathers has a powerful command line interface. Here are a few things it can do:
-
-``` bash
-$ npm install -g feathers-cli             # Install Feathers CLI
-
-$ feathers generate service               # Generate a new Service
-$ feathers generate hook                  # Generate a new Hook
-$ feathers generate model                 # Generate a new Model
-$ feathers help                           # Show all commands
-```
+This is the backend of HC.<br />
+It uses the FeathersJS, NodeJS, yarn and mongoDB.<br />
 
 ## Help
-
-For more information on all the framework related things visit [docs.feathersjs.com](http://docs.feathersjs.com).
-
-The HC platform is documented in our [gitbook](https://www.gitbook.com/book/human-connection/documentation/) (work in progress).
+The HC platform and its setup is documented in our [docs](https://docs.human-connection.org/) (work in progress).<br />
+Connect with other developers over [Discord](https://discord.gg/6ub73U3)<br />
 
 ## License 
-
-Copyright (c) 2018 [Human-Connection.org](https://human-connection.org)
-
-Licensed under the [MIT](https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md) license.
+Copyright (c) 2018 [Human-Connection.org](https://human-connection.org)<br />
+Licensed under the [MIT](https://github.com/Human-Connection/WebApp/blob/develop/LICENSE.md) license.<br />

config/cucumber.json

@@ -0,0 +1,5 @@
+{
+  "baseURL": "http://api.127.0.0.1.xip.io:3030",
+  "mongodb": "mongodb://mongo:27017/hc_api",
+  "host": "0.0.0.0"
+}

config/default-docker.json

@@ -11,14 +11,20 @@
     "max": 100
   },
   "thumbor": {
-    "url": "",
-    "key": ""
+    "url": false,
+    "key": false
   },
   "apiSecret": "TE9TqAk2xK[9EFJL",
   "sentry": {},
   "seeder": {
-    "runOnInit": true,
-    "dropDatabase": true
+    "runOnInit": false,
+    "dropDatabase": false
+  },
+  "defaultEmail": "[email protected]",
+  "smtpConfig": {
+    "host": "0.0.0.0",
+    "port": 1025,
+    "ignoreTLS": true
   },
   "mongodb": "mongodb://localhost:27017/hc_api",
   "authentication": {

config/default.json

@@ -0,0 +1,15 @@
+{
+  "seeder": {
+    "runOnInit": true,
+    "dropDatabase": false
+  },
+  "smtpConfig": {
+    "host": "maildev",
+    "port": 25,
+    "ignoreTLS": true
+  },
+  "thumbor": {
+    "url": "http://thumbor.127.0.0.1.xip.io:8000",
+    "key": ""
+  }
+}

config/local-staging-docker.json

@@ -1,20 +1,6 @@
 {
-  "host": "localhost",
-  "port": 3030,
-  "baseURL": "http://localhost:3030",
-  "frontURL": "http://localhost:3000",
-  "smtpConfig": {
-    "host": "0.0.0.0",
-    "port": 1025,
-    "ignoreTLS": true
-  },
-  "thumbor": {
-    "url": "",
-    "key": ""
-  },
   "seeder": {
     "runOnInit": true,
     "dropDatabase": false
-  },
-  "defaultEmail": "[email protected]"
+  }
 }

config/local.example.json

@@ -0,0 +1,3 @@
+{
+  "mongodb": "mongodb://mongo:27017/hc_api_test"
+}