Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.32 KB

README.md

File metadata and controls

41 lines (26 loc) · 1.32 KB

VLCTechHub API

Public API for VLCTechHub

How to use it

  • Clone the project git clone [email protected]:VLCTechHub/VLCTechHub-api.git
  • Install ruby 2.3.0 (you might want to install it with rbenv)
  • Install mongo (optional, you can use a remote service)
  • Install bundle & run bundle install
  • Build the project with bundle exec rake build
  • Configure your mongo connection uris in .env (not necesary if you use local mongo with default values)
  • Run bundle exec rake up
  • Visit http://localhost:5000

How to restore dev database

  • Run bundle exec rake mongo:prepare

How to run the tests

  • Run bundle exec rake test

How to use Docker containers for development

  • Install Docker Engine and Docker Compose.
  • The first time you use it, you will need to build the containers: docker-compose build
  • To start the container, just use docker-compose up

--

Build Status