Thanks to visit codestin.com
Credit goes to github.com

Skip to content

mosesogwo/Xplore-API

Repository files navigation

Xplore-API

A Rails API for Xplore App. Xplore is a listing of vacation packages.

Built With

  • Ruby
  • Rails
  • Postgresql
  • RSpec

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Ruby v2.6.3
  • Rails v5.2.4
  • Postgresql

Setup & Install

  • Clone this repository and cd into the project directory.
  • Run bundle install
  • Run rails db:create
  • Run rails db:migrate
  • Run rails server
  • Install httPie for sending requests from terminal.

Usage

To get a list of all packages:

  • Run - http get :3000/api/v1/packages

To get a user's wishlist

  • Run - http get :3000/api/v1/wishes username='insert user's name'

To add a package to a user's wishlist.

  • Run - http post :3000/api/v1/wishes username='insert user's name' id='insert package_id'

Run tests

To run tests,

  • Run - bundle exec rspec

Upcoming features

  • Authentication with JWT

Author

👤 Moses Ogwo

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Acknowledgments

📝 License

This project is MIT licensed.

About

A Rails back-end for Xplore App.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published