Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.21 KB

README-EN.md

File metadata and controls

61 lines (43 loc) · 2.21 KB
Raw

t-creo-back-end

npm type definitions Coverage Status

Backend for the T-CREo Application. Miniproject of software development of Simon Bolivar University.

Members

  • Yuni Quintero
  • Germán Robayo
  • Nairelys Hernandez
  • Fabiola Martinez
  • David Cabeza
  • Jose Acevedo

Mentors

  • Yudith Cardinale
  • Irvin Dongo

Installation

Requirements

It is only needed to have nodejs lts/dubnium (v10.16.0). It is recommended to use nvm to manage local nodejs versions.

How to run

On development

  1. Run npm install to download all dependencies.
  2. On the root of the project, create an .env file with the following contents:
PORT=3000 # Port where server will listen for requests. Normally its value its 3000
TWITTER_CONSUMER_KEY: '' # Consumer key provided by twitter after applying for API access
TWITTER_CONSUMER_SECRET: '' # Consumer secret provided by twitter after applying for API access
  1. Run npm start to run the development server. Changes are auto-reloaded after saving any file.
  2. Visit http://localhost:3000/health
  3. Check that response has 200 status code and a body { "status": "UP" }.

How to contribute

  1. Clone the repository and do a checkout to the develop branch.
  2. Create a branch with your contribution. The branch should follow the branching name conventions
  3. When finished, issue a Pull request to integrate your branch to develop. Request review from all members of the team.

Branching name conventions

  • feature/* for branches that introduce features. Example: feature/add-facebook-support.
  • bugfix/* for branches that introduce patches and bugfixes. Example: bugfix/fix-weight-calculation.

Who do I talk to?

You can contact any contributor and member of the T-CREO team with any subject, though the most active maintainer is @german1608.