To effectively use the modern technology to enhance the tourism in Srilanka.

Installation

• (Use yarn to install the dependencies (recommended). Install yarn with these docs.)

yarn install

or

• (Use npm/npx to install the dependencies.)

npm install

This command will install all the dependencies for the API. Next rename the .env.example to .env and update the configuration.

Run

yarn run dev

Deployment Stages

1. develop (dev): automated deployment to dev environment
2. production (master): automated deployment to production environmen

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

• All features or bug fixes must be tested by one or more specs (unit-tests).
• All public API methods must be documented.

Commit Message Guidelines

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests

Submitting a Pull Request (PR)

Before you submit your Pull Request (PR) consider the following guidelines:

1. Make your changes in a new git branch:

   git checkout -b my-fix-branch master

2. Create your patch, including appropriate test cases.

3. Follow our Coding Rules.

4. Commit your changes using a descriptive commit message that follows our commit message conventions.

5. In GitHub, send a pull request to traverser-client:dev.