Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/omarsalem7/capstone-back-end

Golf reservations backend is rails backend application for Golf book reservations. This applications take works for API endpoints and users can load, create, and delete courses and reservations. Users need to sign up or sign in to access the API endpoints. They can sign up or sign in using the API endpoints.
https://github.com/omarsalem7/capstone-back-end

api devise-jwt postgresql rspec-rails ruby-on-rails

Last synced: 19 days ago
JSON representation

Golf reservations backend is rails backend application for Golf book reservations. This applications take works for API endpoints and users can load, create, and delete courses and reservations. Users need to sign up or sign in to access the API endpoints. They can sign up or sign in using the API endpoints.

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/goldensquad-orange)

# Book A Golf Course Backend

> Book A Golf Course backend is rails backend application for booking golf courses. This applications works with API endpoints and users can load, create, and delete Coursess and Add reservations. Users need to sign up or sign in to access the API endponits. They can sign up or sign in using the API endponts.

## Front End Repo

[Book Appointments Frontend](https://github.com/BenjaminSemah/capstone-front-end.git)

## Kanban Board
[Kanban Board](https://github.com/omarsalem7/capstone-back-end/projects/2)

## Initial state Of Kanban Board
[Initial Kanban Board](https://github.com/omarsalem7/capstone-back-end/issues/17)

> ***We are a group of five***
1. Team 1 - [Butler](https://github.com/butlermuwo)
2. Team 2 - [Stephan](https://github.com/sneeu-leeu)
3. Team 3 - [Josphat](https://github.com/zairdon20)
4. Team 4 - [Omar](https://github.com/omarsalem7)
5. Team 5 - [Benjamin](https://github.com/BenjaminSemah)

## Built With

- Major languages (Ruby)
- Framworks (Ruby on Rails)
- Testing library (Rspec)
- API docs (Rswag)

## Live version

[In progress]

## Getting Started

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

### Prerequisites
- A text editor(preferably Visual Studio Code)

### Install
- Ruby
- Ruby on Rails
- PostgresSQL

### Using it Locally

- Clone the project
```
git clone https://github.com/omarsalem7/capstone-back-end
cd capstone-back-end
```

### Setup

Add your username & password in `database.yml` file:
```
username:
password:
```
Specify your ruby version if different from mine
```
ruby 'Your_ruby_version'
```

Install gems with:

```
bundle install
```

Setup database with:

```
rails db:create
rails db:migrate
rails db:seed
```
### Usage

Start server with:

```
rails server -p 3001
```

Visit http://localhost:3001/ in your browser.

### Run tests

Install npm with:

```
npm install
```

Install rspec with:

```
bundle install
```

and

```
rails generate rspec:install
```

run the test with:

```
rspec spec
```
### Open API documentation

```
rails rswag:specs:swaggerize
```

Visit http://localhost:3001/api-docs in your browser.

## Visit And Open Files

[Visit Repo](https://github.com/omarsalem7/capstone-back-end)

## Authors

👤 **Omar Salem**

- GitHub: [Omar Salem](https://github.com/omarsalem7)
- Twitter: [Omar Salem](https://twitter.com/Omar80491499)
- LinkedIn: [Omar Salem](https://www.linkedin.com/in/omar-salem-a6945b177/)

👤 **Stephan**

- GitHub: [@stephan](https://github.com/sneeu-leeu)
- Twitter: [@Stephan](https://twitter.com/Stephan07484055)
- LinkedIn: [Stephan Annandale](https://www.linkedin.com/in/stephan-annandale-a4b4931a9/)

👤 **Josphat Nkonde**

- GitHub: [@zairdon20](https://github.com/zairdon20)
- Twitter: [@josphat1 nkonde](https://twitter.com/josphat-nkonde)
- LinkedIn: [@josphat nkonde](https://www.linkedin.com/in/josphat-nkonde)

👤 **Benjmain Semah**

- GitHub: [@BenjaminSemah](https://github.com/BenjaminSemah)
- Twitter: [@BenjaminSemah](https://twitter.com/BenjaminSemah)
- LinkedIn: [@BenjaminSemah](https://www.linkedin.com/in/benjaminsemah/)

👤 **Butler shimalwani**

- GitHub: [@Butlermuwo](https://github.com/butlermuwo)
- Twitter: [@Butlermuwo](https://twitter.com/ButlerMuwo)
- LinkedIn: [@Butlermuwo](https://www.linkedin.com/in/butlermuwo)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/omarsalem7/capstone-back-end/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Inspiration: Microverse

## 📝 License

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