Merge pull request #12 from opatut/docker

Docker setup

.gitignore

@@ -35,3 +35,11 @@ node_modules
 .node_repl_history
 
 .idea
+
+# Storage place for local files, such as developer database etc.
+local/
+
+# We don't include this file in favor of package-lock.json -- we cannot have
+# both, because then developers will only update one of them and they'll
+# contradict. For now, npm shall be the canonical default (compare README.md).
+yarn.lock

Dockerfile

@@ -0,0 +1,11 @@
+FROM node:14
+
+WORKDIR /opt/obsAPI
+ADD package.json package-lock.json /opt/obsAPI/
+RUN npm ci
+
+ADD _helpers _middleware accounts config models public routes app.js /opt/obsAPI/
+
+EXPOSE 8080
+ENV PORT=8080
+CMD ["npm", "start"]

README.md

@@ -1,37 +1,103 @@
 # OpenBikeSensor Web API
+
 The backend API for the [OpenBikeSensor](https://zweirat-stuttgart.de/projekte/openbikesensor/) Web App.
 
-## Running it
+## Direct setup
-### Requirements
-A working installation of npm and node.js - get the latest node.js LTS release at [the node.js homepage](https://nodejs.org/en/) and verify it's working via `node -v` and `npm -v` in a command prompt of your choice.
 
-A working installation of [Docker](https://www.docker.com) for the used containerized MongoDB. 
+### Requirements
+
+* A working installation of npm and node.js - get the latest node.js LTS
+  release at [the node.js homepage](https://nodejs.org/en/) and verify it's
+  working via `node -v` and `npm -v` in a command prompt of your choice. At
+  least node version 10.x is required.
+* A working installation of [Docker](https://www.docker.com) for the
+  containerized MongoDB. Alternatively, you can set up your own MongoDB
+  elsewhere.
 
 ### First start
-To get started you need to download all used packages with `npm i` in the project's root folder first.
 
-Next up is our local MongoDB. This uses docker but can be conveniently started via `sudo npm run mongo:start` (at least in Ubuntu Linux).
+To get started you first need to download all dependencies in the project's
+root folder:
 
-Afterwards the dev server is started with `npm run dev` and can be called via `http://localhost:3000/api`.
+    npm install
 
-To completely stop the project after running it a call to `sudo npm run mongo:stop` is necessary.
+Next up we have to run a MongoDB instance. The following command uses docker,
+it assumes you have the docker daemon installed and running.  Working with
+docker might require root privileges, depending on your docker setup, so you
+might want to prefix the following command with `sudo`:
 
-### Running the tests
+    npm run mongo:start
-Just execute `npm run test` while both the node.js server and the MongoDB are up and running.
 
-Warning: At the moment (2020-09-29) there are no tests.
+The development server will be accessible at `http://localhost:3000/api` after
+starting it like this:
+
+    npm run dev
+
+To stop the database when you're done developing, run (potentially with sudo):
+
+    npm run mongo:stop
+
+## Docker setup 
+
+If you have docker and don't want to bother installing Node.js on your machine,
+you can run the application inside docker as well:
+
+    docker-compose up -d
+    
+This will first build the `obs-api` image, which contains all the steps
+outlined above, and then run the services, both a mongodb and the api itself,
+in docker containers. Interaction with the processes is different though,
+expect other guides or commands to work differently in this type of setup.
+
+
+## Custom MongoDB installation
+    
+If you have your own MongoDB instance running somewhere, you can set the
+environment variable `MONGODB_URL` when starting the server, and it will read
+that URL for connecting.
+  
+    export MONGODB_URL=mongodb://user:password@mongodb.example.com/obs-app-database
+    
+This does not work when using docker-compose, in that case, you will have to
+modify the `docker-compose.yaml` to include that URL.
+
+
+## Usage
 
 ### Uploading a track for test purposes
-Uploading a track to the local server requires multiple steps, as uploading is not possible via the dummy upload form in the corresponding web app yet:
+
-- Create a user in the web app and copy the user id, which can be found at (http://localhost:4200/settings) as "API key"
+Uploading a track to the local server requires multiple steps, as uploading is
-- Import the [Postman](https://www.postman.com) script "add-track.json" from the "postman-examples" into Postman
+not possible via the dummy upload form in the corresponding web app yet:
-- In each of the three requests add your user id in the "Pre-request script" tab as the value for the "UserId" variable
+
-- As tracks have to be split into smaller parts to get a working upload from the sensor you have to run the three requests in the order of: begin -> add -> end
+- Create a user in the web app and copy the user id, which can be found at
-- View your freshly uploaded track at (http://localhost:4200) -> Home -> Your feed
+  (http://localhost:4200/settings) as "API key"
+- Import the [Postman](https://www.postman.com) script "add-track.json" from
+  the "postman-examples" into Postman
+- In each of the three requests add your user id in the "Pre-request script"
+  tab as the value for the "UserId" variable
+- As tracks have to be split into smaller parts to get a working upload from
+  the sensor you have to run the three requests in the order of: begin -> add
+  -> end
+- View your freshly uploaded track at (http://localhost:4200) -> Home -> Your
+  feed
 
 ### Sending E-Mails
-By default in development mode mails are not sent, but instead the mail data is logged to the console. This can be overriden with the `--devSendMails` flag if you start the application like so: `npm run dev -- --devSendMails`.
+
+By default in development mode mails are not sent, but instead the mail data is
+logged to the console. This can be overriden with the `--devSendMails` flag if
+you start the application like so: `npm run dev -- --devSendMails`.
 
 Mails are also always sent in production mode!
 
-For actually sending e-mails the mailserver, sender, user and password for the SMTP server need to be specified as environment variables. The username is read from `MAILUSER`, and the password is read from `MAILPW`, Mailserver is read from 'MAILSERVER' and the sender name from 'MAILSENDER', so in local development startup would like something like this (at least in Linux): `MAILSERVER=mail.my-domain.de MAILSENDER=noreply@whatever.de MAILUSER=myuser MAILPW=supersecurepassword npm run dev -- --devSendMails`.
+For actually sending e-mails the mailserver, sender, user and password for the
+SMTP server need to be specified as environment variables: 
+
+* `MAILUSER` -- the smtp mailbox login name
+* `MAILPW` -- password for the mailbox
+* `MAILSERVER` -- the hostname of the SMTP server, e.g. `mail.example.com`
+* `MAILSENDER` -- sender name, e.g. `noreply@example.com`
+
+Full command example:
+
+    MAILSERVER=mail.example.com MAILSENDER=noreply@example.com MAILUSER=my_mail_login
+MAILPW=hunter2 npm run dev -- --devSendMails

app.js

@@ -30,12 +30,9 @@ if (!isProduction) {
   app.use(errorhandler());
 }
 
-if (isProduction) {
+const mongodbUrl = process.env.MONGODB_URL || (isProduction ? 'mongodb://localhost/obs' : 'mongodb://localhost/obsTest')
-  mongoose.connect('mongodb://localhost/obs');
+mongoose.connect(mongodbUrl);
-} else {
+mongoose.set('debug', !isProduction);
-  mongoose.connect('mongodb://localhost/obsTest');
-  mongoose.set('debug', true);
-}
 
 require('./models/TrackData');
 require('./models/User');

docker-compose.yaml

@@ -0,0 +1,35 @@
+version: '3'
+
+services:
+    mongo:
+        image: mongo
+        tty: true
+        volumes:
+            - ./local/mongo:/data/db
+        ports:
+            - '27017:27017'
+        restart: on-failure
+
+    api:
+        image: obs-api
+        build:
+          context: .
+          dockerfile: ./Dockerfile
+        volumes:
+          - ./_helpers:/opt/obsAPI/_helpers
+          - ./_middleware:/opt/obsAPI/_middleware
+          - ./accounts:/opt/obsAPI/accounts
+          - ./config:/opt/obsAPI/config
+          - ./data:/opt/obsAPI/data
+          - ./models:/opt/obsAPI/models
+          - ./public:/opt/obsAPI/public
+          - ./routes:/opt/obsAPI/routes
+          - ./app.js:/opt/obsAPI/app.js
+        environment:
+            - PORT=3000
+            - MONGODB_URL=mongodb://mongo/obsTest
+        links:
+          - mongo
+        ports:
+            - '3000:3000'
+        restart: on-failure