Add fully functioning server

.dockerignore

@@ -0,0 +1,24 @@
+node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+npm-debug.log
+
+Dockerfile*
+.docker-compose*
+.dockerignore
+
+.git
+.gitignore
+
+.env.example
+*.example.json
+
+*.md
+!README.md
+LICENSE
+.vscode

.env.example

@@ -1,21 +1,40 @@
-API_URL=http://localhost:8000
-CLIENT_URL=http://localhost:3000
-CORS_ORIGIN=http://localhost:3000
+APP_SECRET=something_secret
+SESSION_SECRET=something_secret
 
+# Provide service_name for DB_HOST while running in docker, otherwise use localhost
+DB_HOST=localhost
+# Provide exposed docker port while running in docker, otherwise use 27017
+DB_PORT=27017
+# DB_AUTH_ENABLED (true or false)
+DB_AUTH_ENABLED=false
+DB_AUTH_SOURCE=admin
+DB_NAME=JSPF
 DB_USERNAME=db_username
 DB_PASSWORD=db_password
-DB_URI=mongodb://localhost/JSPF
 
-PORT=8000
+# Provide service_name to REDIS_HOST(redis) while running in docker
+# While running in normal mode, provide host (localhost)
+REDIS_HOST=redis
+REDIS_PORT=6379
+
+APP_PORT=8000
+KUE_PORT=5000
 DEBUG=true
+MAINTENANCE=false
+environment=development
+
+SENDGRID_API_KEY=
+
+API_BASE_URL=http://localhost:8000
+CLIENT_BASE_URL=http://localhost:3000
 
-APP_SECRET=something secret
-SESSION_SECRET=something secret
+BASE_DIR=
+CLIENT_BASE_DIR=
 
 [email protected]
 START_DATE=// dd-mm-yyyy
 END_DATE=// dd-mm-yyyy
 START_DATE_JS=// mm-dd-yyyy
 END_DATE_JS=// mm-dd-yyyy
 START_YEAR=// yyyy
-END_YEAR=// yyyy
+END_YEAR=// yyyy

.gitignore

@@ -1,2 +1,18 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+*.out
+
+docker/data/*
+
+.vscode/
 node_modules/
-.env
+.env
+google_auth_credentials.json
+google_auth_token.json
+google_auth_service_jwt.json
+mentorsList.json

README.md

@@ -1,2 +1,36 @@
 # JSPF-Server
-Backend for Jitheshraj Scholarship Portal Form.
+Backend for Jitheshraj Scholarship Portal Form.
+
+### Prerequisites
+* Install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+* Install [MongoDB](https://docs.mongodb.com/manual/administration/install-community/)
+* Install [redis](https://redis.io/) :
+    ```
+    sudo apt-get install redis-server
+    ```
+
+### Project Installation
+1. Clone the repository - `git clone <remote-url>`
+2. Go to the project directory - `cd <cloned-repo>`
+3. Install dependencies - `npm install`
+4. Copy contents of `.env.example` to a new file `.env`
+    * Configure `PORT`, `environment` and `SECRET` variables
+    * Set `DB_USERNAME`, `DB_PASSWORD` and `DB_URI` to your localhost mongodb credentials
+    * Get and set `SENDGRID_API_KEY` to access application mailing routes
+    * `API_BASE_URL = 'http://localhost:8000'`
+    * `CLIENT_BASE_URL = 'http://localhost:3000'`
+    * Set `BASE_DIR` and `CLIENT_BASE_DIR` to your appropriate directories path to configure file uploads.
+    * Set the `DATE` and `YEAR` variables in their respective formats. You won't be able to access certain routes without this.
+5. Copy contents of `src/config/google_auth_credentials.example.json` to a new file `src/config/google_auth_credentials.json` and set all the parameters and configure accordingly in Google developer console to give Google Drive API upload/write access.
+6. Copy contents of `src/config/mentorsList.example.json` to a new file `src/config/mentorsList.json` and add all the mentors details.
+7. Start `MongoDB` service - `sudo service mongod start` 
+8. Start application and kue server - `node index`
+9. Open a new terminal and start kue workers - `node /src/workers`
+10. Instead, to start both servers and workers - `./run_server.sh`
+11. Access kue API and dashboard from http://localhost at its configured _port_ number. Or at http://localhost:5000/api and http://localhost:5000/kue respectively, by default.
+12. Install _JSPF-Web_ if needed, from [BharathKumarRavichandran/JSPF-Web](https://github.com/BharathKumarRavichandran/JSPF-Web)
+
+#### Troubleshooting
+* If you face some version incompatability issues while installing/running, check your `node` and `npm` versions and ensure it is compatible with the project. (Tip: Use nvm :p)
+* If you face any mongo error, check whether `MongoDB` service (_mongod_ daemon) is running.
+* If you're unable to generate PDFs, make sure your [wkhtmltopdf](https://www.npmjs.com/package/wkhtmltopdf) rendering engine(_QT_) path is configured properly.

docker-compose.yml

@@ -0,0 +1,38 @@
+version: '3'
+
+services:
+
+  redis:
+    image: redis:3.0-alpine
+    container_name: jspf-redis
+    command: redis-server
+    volumes:
+    - './docker/data/redis:/data'
+    ports:
+    - "6379:6379"
+
+  mongodb:
+    image: 'mongo'
+    container_name: jspf-mongo
+    env_file:
+    - './docker/mongo/.env'
+    volumes:
+    - './docker/data/mongodb:/data/db'
+    ports:
+    - '27017:27017'
+
+  node_app:
+    build:
+      context: ./
+      dockerfile: ./docker/build_files/Dockerfile
+    container_name: jspf-server
+    restart: always
+    volumes:
+        - ./storage/logs:/usr/src/app/storage/logs
+        - ../JSPF-Web/public/uploads:/usr/src/app/public/uploads
+    ports:
+    - '5000:5000'
+    - '8000:8000'
+    depends_on:
+    - mongodb
+    - redis

docker/build_files/Dockerfile

@@ -0,0 +1,20 @@
+FROM node:8-alpine
+
+WORKDIR /usr/src/app
+
+COPY ./scripts ./scripts
+RUN ./scripts/install_packages.sh
+
+RUN Xvfb :1 -screen 0 800x600x24&
+RUN Xvfb :99 -ac &
+
+ENV NODE_ENV=production
+
+COPY ./package*.json ./
+RUN npm install --only=production
+COPY . ./
+
+EXPOSE 5000
+EXPOSE 8000
+
+CMD ["./scripts/node_app_entry.sh"]

docker/mongo/.env.example

@@ -0,0 +1,2 @@
+MONGO_INITDB_ROOT_USERNAME=root
+MONGO_INITDB_ROOT_PASSWORD=rootPassXXX

docker/nginx/default.conf

@@ -0,0 +1,32 @@
+server {
+
+    listen 80;
+    server_name form.jrscholarship.org;
+
+    access_log /var/log/nginx/access.log;
+
+    # listen 443 ssl;
+
+    # ssl_certificate /etc/nginx/conf.d/nginx.crt;
+    # ssl_certificate_key /etc/nginx/conf.d/nginx.key;
+
+    location / {
+        proxy_set_header Host $host;
+        proxy_pass http://0.0.0.0:3000/;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    } 
+
+    location /api {
+        proxy_set_header Host $host;
+        proxy_pass http://0.0.0.0:8000/;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }   
+}

index.js

@@ -1 +1,5 @@
-require('./src/server').start()
+// Start app server
+require('./src/server.js').start();
+
+// Start kue server
+require('./src/kue.server.js').start();