Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

44 lines (35 loc) · 2.19 KB
Raw

Contribute to EDDB API

Thank you for contributing to this project. All contributions are welcome. But for the sake of sanity please follow the guidlines for contribution.

Requirements

  1. NodeJS v8.9.0 (Carbon) and above
  2. MongoDb 3.2 and above
  3. (Optional) Bugsnag API token
  4. cronTimes.js file placed alongside server.js
  5. secrets.js file placed alongside server.js
  6. Git
  7. Github account
  8. (Optional) A good IDE or code editor

Setup

  • Make sure MongoDB is installed and running.
  • Create a database in the mongodb instance, eddb_api.
  • Fork and then clone the repo using git clone [email protected]:[your-username]/eddbapi.git. (Note: Forking is required only when you do not have developer access to the Github repository)
  • Make sure you checkout the master branch first.
  • Create a new branch to work on using git checkout -b [name-of-your-new-branch].
  • Run npm i to install all the dependencies.
  • Create a file alongside server.js called secrets.js. This file will contain all the secret tokens used by the project. The file needs to have the following content. Make sure to verify that MongoDB is running at port 27017. If not, change here accordigly. 
    "use strict";
let eddb_api_db_user = "[username for eddb_api db]";
let eddb_api_db_pwd = "[password for eddb-api db]";
module.exports.eddb_api_db_url = `mongodb://${eddb_api_db_user}:${eddb_api_db_pwd}@localhost:27017/eddb_api`;

// Bugsnag is optional
module.exports.bugsnag_token = "[Bugsnag token]";
  • Create a file alongside server.js called cronTimes.js. This file will contain the time string at which the data dumps from EDDB will be downloaded. The program needs to be restarted after changing the contents of this file. 
    "use strict";

module.exports.eddb_trigger_time = "[HH:MM:SS]";
  • To execute the project run npm run startdev. This executes the project in development Environment. To test the production environment run npm start.

Pushing changes

After you have made the necessary changes and committed them push them to your forked repository. Then create a pull request to the master base branch. I will review the PR and might ask to make changes before accepting them.