/rogue-backend

Primary LanguageJavaScriptMIT LicenseMIT

Build Status Coveralls github branch Build Status

Barefoot Nomad

Barefoot Nomad is an application that will enable its "Company Nomads" book their international travel and accommodation globally, easily and conveniently across all the locations/centers where the company has its operation.

Vision

Our vision is to make global travel and accommodation easy and convenient for the strong workforce of savvy members of staff, by leveraging the modern web.

Technologies

  • Es6+ Javascript The project was written with ES6 syntax and above.
  • Node/Express A JavaScript runtime built on Chrome's V8 JavaScript engine.
  • PostgreSQL The World's Most Advanced Open Source Relational Database.
  • Swagger Used for API documentation. Simplify API development for developers by helping to document APIs.
  • Pivotal Tracker A project management tool used to manage the app.
  • Figma Used for design mockups. It helps teams to design, prototype, and collaborate all in the browser.
  • Yarn Used as the package manager for the app. A fast, reliable, and secure dependency management system.

UI Design

The mockups for the app design can be viewed here Barefoot Nomad/UI link

REST API Docs

The Api documentation is done using swagger. View Barefoot Nomad API Documentation

JWT Authentication

The API endpoints are being authenticated using JWT(Json Web Token).

Required Features

User can sign up.
User can sign in.
User can book travel
User can book accommodation
User can view travel and accommodation history on dashboard
User can update travel and accommodation requests
User can delete requests
User can rate trips and accommodations
User can view reviews
User can chat with other users
User roles: Super Admin, Travel Admin, Travel Team Member, Manager, Requester
User can sign out from Barefoot Nomad
Admins can create bookings
Admins can update bookings
Admins can delete bookings

Installation and Running the Application

  • Clone the repository using: git clone https://github.com/andela/rogue-backend.git
  • Run yarn install To install the project dependencies
  • Run sequelize db:migrate To create all tables by running migrations
  • Run yarn dev-start To start the application
  • Run yarn test to run test

Contributors

License

MIT