tsheporamantso/final-capstone-rails-api

This is API only application

StaySphere

📗 Table of Contents

• 📗 Table of Contents
• 📖 StaySphere
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 📋Kanban board
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 StaySphere

StaySphere this app built with Rails and React on two different apps. This application enables users to signin/signup create hotels/AirBnb listings and create reservations on each hotel.

🛠 Built With

• Ruby on Rails
• React and Redux

Tech Stack

• Ruby
• Rails
• Postgresql

Key Features

• [React Components]
• [Redux]
• [Database]
• [Rails API]

(back to top)

🚀 Live Demo

• Coming soon.
• Link to Stay Sphere front-end repository

(back to top)

📋 Kanban Board

Link to Kanban board

Link to initial kanban board state

We are a team of three:

• 👤 Gladwin Tshepo Ramantso
• 👤 George Hamman
• 👤 Evans Kofi Nyamekye

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• VScode
• Ruby
• Rails
• Postgres

Setup

Clone this repository to your desired folder:

Make sure you setup and run the back-end first.

  git clone git@github.com:tsheporamantso/final-capstone-react-front-end.git
  cd final-capstone-react-front-end

Install

Install this project with:

  bundle install

  rails db:create

  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Test

Please run the following commands for test:

  rspec spec/models
  rake rswag

Deployment

Not deployed

(back to top)

👥 Authors

👤 Gladwin Tshepo Ramantso

• GitHub: @tsheporamantso
• Twitter: @ramgt001
• LinkedIn: Tshepo Gladwin Ramantso

👤 George Hamman

• GitHub: @githubhandle
• LinkedIn: George Hamman

👤 Evans Kofi Nyamekye

• GitHub: evansnyamekye
• Twitter: @nyamekye2131
• LinkedIn: Evans Kofi Nyamekye

(back to top)

🔭 Future Features

• Improve Styling
• Specific room selection with each place
• Check to see if a person can book the hotel if they have rooms available

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to leave a star and/or follow me on Github.

(back to top)

🙏 Acknowledgments

I would like to thank the code reviewers for taking the time to review our project and for Microverse for supplying it. Also I would like to thank Murat Korkmaz on Behance for the design inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)