Skip to content

Latest commit

 

History

History
36 lines (33 loc) · 2.46 KB

README.md

File metadata and controls

36 lines (33 loc) · 2.46 KB
Raw

JSPF-Server

Backend for Jitheshraj Scholarship Portal Form.

Prerequisites

  • Install npm
  • Install MongoDB
  • Install redis : 
    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

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 rendering engine(QT) path is configured properly.