https://github.com/tsheporamantso/final-capstone-rails-api
This is API only application
https://github.com/tsheporamantso/final-capstone-rails-api
api-rest devise-token-auth postgresql postman-test rails rswag-specs ruby
Last synced: 7 months ago
JSON representation
This is API only application
- Host: GitHub
- URL: https://github.com/tsheporamantso/final-capstone-rails-api
- Owner: tsheporamantso
- License: mit
- Created: 2024-02-23T06:45:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-07T12:15:27.000Z (over 1 year ago)
- Last Synced: 2025-01-19T23:33:23.797Z (9 months ago)
- Topics: api-rest, devise-token-auth, postgresql, postman-test, rails, rswag-specs, ruby
- Language: Ruby
- Homepage:
- Size: 146 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
StaySphere
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 StaySphere ](#-staysphere-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [ :clipboard:Kanban board ](#-kanban-board-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**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.
- **Ruby on Rails**
- **React and Redux**
- Ruby
- Rails
- Postgresql
- **[React Components]**
- **[Redux]**
- **[Database]**
- **[Rails API]**
- Coming soon.
- [Link](https://github.com/tsheporamantso/final-capstone-react-front-end) to Stay Sphere front-end repository
[Link](https://github.com/users/tsheporamantso/projects/14) to Kanban board
[Link](https://github.com/tsheporamantso/final-capstone-rails-api/issues/5) to initial kanban board state
We are a team of three:
- 👤 **Gladwin Tshepo Ramantso**
- 👤 **George Hamman**
- 👤 **Evans Kofi Nyamekye**
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.
```sh
git clone git@github.com:tsheporamantso/final-capstone-react-front-end.git
cd final-capstone-react-front-end
```
### Install
Install this project with:
```sh
bundle install
```
```sh
rails db:create
```
```sh
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Test
Please run the following commands for test:
```sh
rspec spec/models
rake rswag
```
### Deployment
Not deployed
👤 **Gladwin Tshepo Ramantso**
- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)
👤 **George Hamman**
- GitHub: [@githubhandle](https://github.com/George7h)
- LinkedIn: George Hamman
👤 **Evans Kofi Nyamekye**
- GitHub: [evansnyamekye](https://github.com/evansnyamekye)
- Twitter: [@nyamekye2131](https://twitter.com/nyamekye2131)
- LinkedIn: [Evans Kofi Nyamekye](https://www.linkedin.com/in/evans-kofi-nyamekye-1980a4117/)
- [ ] **Improve Styling**
- [ ] **Specific room selection with each place**
- [ ] **Check to see if a person can book the hotel if they have rooms available**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/tsheporamantso/final-capstone-react-front-end/issues).
If you like this project feel free to leave a star and/or follow me on Github.
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](https://www.behance.net/muratk) on Behance for the design inspiration.
This project is [MIT](https://github.com/tsheporamantso/final-capstone-rails-api/blob/c38877860d5f2a401f246315074edcb5719f42fd/LICENSE) licensed.