Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/newhoteng/spa-booking-backend


https://github.com/newhoteng/spa-booking-backend

Last synced: 14 days ago
JSON representation

Awesome Lists containing this project

README 

        






  
The Spa Api






# 📗 Table of Contents



- [📗 Table of Contents](#-table-of-contents)

- [📖 The Spa Api ](#-the-spa-api-)

  - [🛠 Link to back-end ](#-link-to-back-end-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [🚀 Live Demo ](#-live-demo-)

  - [Video Presentation ](#video-presentation-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Database ERD diagram](#database-erd-diagram)

    - [Get into development](#get-into-development)

    - [Run test](#run-test)

    - [Kanban board](#kanban-board)

    - [Final statement](#final-statement)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [🤝 API Documentation ](#-api-documentation-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)



# 📖 The Spa Api 



**The Spa Api** is the backend rails Api for the spa app built to help individuals easily book their spa sessions.



## 🛠 Link to back-end 



-- [Link to frontend-end!](https://github.com/newhoteng/spa-booking-frontend)



(back to top)



## 🛠 Built With 



### Tech Stack 



Client

  



Database

  



### Key Features 



- **Set up controller**

- **Authentication with devise**

- **View the all services available**

- **Users can add services**

- **Users can make reservation of services**

- **Users can view all reservations they have made**

- **Users can delete services**



(back to top)



## 🚀 Live Demo 



- [Live Demo]()



## Video Presentation 



-[Presentation Video]()



## 💻 Getting Started 



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



### Prerequisites



In order to run this project you need:



- Visual Studio Code.

- Ruby

- Git bash.

- GitHub Account.



### Setup



Install Ruby

Go to github and find the repository The Spa Api

Click on code and copy then go to your gitbash cli on your computer Clone this repository to your desired folder



```sh

  cd my-folder

  git clone https://github.com/newhoteng/spa-booking-backend

  bundle install



```



### Install



```

git clone https://github.com/newhoteng/spa-booking-backend

```



### Usage



To run the project, execute the following in a terminal.



```sh

cd my-project

bundle install



```

### Database ERD diagram

![ERD diagram](images/ERD%20diagram.jpg)



### Get into development



- create database and run migrations



```sh

bin/rails db:setup



```



- start server



```sh

bin/rails server



  OR



rails s

```



### Run test



To run test, run the following command in the terminal



```sh

rspec



```

### Kanban board



[Link Kanban Board](https://github.com/users/newhoteng/projects/10)




[Initial state of our kanban board](https://github.com/newhoteng/spa-booking-backend/issues/17)



### Final statement



I'm proud to be a part of a talented team with 4 members who collaborate to achieve our goals and deliver exceptional results.



(back to top)



## 👥 Authors 



👤 **Umair Hamza**



- GitHub: [@emhamza](https://github.com/emhamza)

- Twitter: [@uhamzaz](https://twitter.com/uhamzaz)

- LinkedIn: [Umair Hamza](https://www.linkedin.com/in/umair-hamza-a8262b261/)



👤 **Harriet Oteng**



- GitHub: [@githubhandle](https://github.com/newhoteng)

- Twitter: [@twitterhandle](https://twitter.com/HarrietOteng1)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/harriet-oteng/)



👤 **Fatihah Oduwole**



- GitHub: [@jeddaa](https://github.com/jeddaa)

- Twitter: [jeddaah](https://twitter.com/_jeddaah)

- LinkedIn: [@jedda](https://linkedin.com/in/fatihahoduwole)



👤 **Roland Ntwali**



- GitHub: [Roland-Ntwali](https://github.com/Roland-Ntwali)

- LinkedIn: [roland-ntwali](https://www.linkedin.com/in/roland-ntwali/)



(back to top)



## 🔭 Future Features 



- **Improve UI**

- **Add payment options**

- **Add more icons**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/newhoteng/spa-booking-backend/issues).



(back to top)



## 🤝 API Documentation 



Api Documentation for our Spa Booking app



Feel free to check the [API Doc](http://127.0.0.1:3001/api-docs/index.html).



(back to top)



## ⭐️ Show your support 



If you like this project please give it a star ⭐️ on github



(back to top)



## 🙏 Acknowledgments 



We would like to thank [Microverse](https://bit.ly/MicroverseTN).



This Project design is adobted based on the Original design idea by [Murat Korkmaz on Behance](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)



(back to top)



## 📝 License 



This project is [MIT](/LICENSE) licensed.



(back to top)