Skip to content

exploresrilanka/traverser-backend

Repository files navigation

logo

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


Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment Stages

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

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-backend:dev.

About

Traverser backend application

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published