explore-indore-be

Back end repository for Explore Indore (Explore Pokhara clone). Currently the dev version of the app is hosted here.

Getting Started

Use the following steps to get started with the dev version of the application:

1. Clone this repository using the command line: git clone https://github.com/2c-indore/explore-indore-be.git
2. Switch to develop branch: git checkout develop
3. Install dependencies: npm install
4. Get data elements from online excel sheet: npm run importdata
5. Dump these data elements to MongoDB: npm run populatedata
6. Copy sample secret config and modify accordingly: cp src/sample_secret_config.json src/secret_config.json
7. Start development server: npm run dev
8. The app will be running at http://localhost:5080

Note: Some of the dependencies are a little old, as a result, there might be weird looking messages when running npm install. We will be fixing them at a later date.

Contributing guide

We will be using the git-flow based model to manage changes to the app.

1. We wiil be maintaining two core branches, master and develop with master containing the last release, and develop containing the latest stable version.
2. All core contributors are required to work on the develop branch.
3. Depending on the nature of the work, branch types can be of two types, feature/feature-name and hotfix/hotfix-name which upon completion of work should be merged to the develop branch.
4. You can learn more about gitflow in this excellent stackoverflow answer.

Bugs and feature requests

We will be using Github issues to solicit and work on issues and feature requests. To submit an issue or feature request, head over to the issues section.