Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 2.83 KB

README.md

File metadata and controls

95 lines (65 loc) · 2.83 KB

Turlista-BE

Build

It means 'timetable' in swedish

Turlista is a group trip planner that simplifies the process of organizing itineraries and tracking expensess for you and your friends.

Documentation

API Docs

This project leverages swagger-blocks for public facing API information.

View Code Documentation

This project conforms to yard for code documentation. To view code docs run:

   script/docs

Project Documentation

For high level design, ADRs, and additional documentation, browse the wiki.

Dependencies

Type Dependency
database Postgres

Environment Variables

name default definition
DB_HOST localhost the host for the DB
DB_PORT 5432 The port for the DB
DB_USER postgres The DB user name
DB_PASS password The DB user password
BASE_PATH localhost:3000 The App URL

Installing

This project makes a best effort to conform to the scripts-to-rule-them-all best practices. The following command should get your development environment up and running in no time.

Mac OS

  script/bootstrap # get dependencies
  script/setup # creates a "clean slate" state

Running

This project has been designed to function as a stand-alone API and can be used as such or in conjunction with a separate front-end application.

Locally

  bundle exec rails s

Testing

Locally

This project leverages the parallelel_tests gem to expedite local test suite execution. Tests may be run from the command line using the provided script.

  script/test

Contributing

License

Creative Commons
License
Turlista by Rebcca Chapin is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Based on a work at https://github.com/rubyDoomsday/turlista-be