https://github.com/paul-js-hub/gym-instructor-backend

A back end API that has gym services
https://github.com/paul-js-hub/gym-instructor-backend

postgresql rails ruby

Last synced: 3 months ago
JSON representation

A back end API that has gym services

• Host: GitHub
• URL: https://github.com/paul-js-hub/gym-instructor-backend
• Owner: Paul-js-hub
• Created: 2023-01-11T13:22:30.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-27T10:52:14.000Z (over 3 years ago)
• Last Synced: 2025-04-11T21:21:30.856Z (over 1 year ago)
• Topics: postgresql, rails, ruby
• Language: Ruby
• Homepage:
• Size: 637 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          




  

  

  


  
Microverse README Template




# 📗 Table of Contents

- [📖 About the Project](#about-project)

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [Kanban board](#kanban-board)  

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 [Gym Instructor API] 

> Describe your project in 1 or 2 sentences.

**[Gym instructor]** is an api end point for a react gym web app to book appointment for different gym

  classes like Yoga. 

## 🛠 Built With 

### Tech Stack 

> Describe the tech stack and include only the relevant sections that apply to your project.

  Client

  


    
React.js

  


  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


### Key Features 

> Describe between 1-3 key features of the application.

- **[Adding a Gym service]**

- **[Register and login using a username]**

- **[Reserving a gym service]**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](Coming Soon)

(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:

 gem install rails

### Setup

Clone this repository to your desired folder:

  git clone https://github.com/Paul-js-hub/hello-rails-back-end.git

  cd hello-rails-back-end

### Install

Install this project with:

- bundle install

- npm install 

- yarn install

- rails db:create 

- rails db:migrate

### Usage

To run the project, execute the following command:

  rails server

### Run tests

To run tests, run the following command:

bundle exec rspec

### Kanban board

- [Screenshot](https://github.com/Paul-js-hub/gym-instructor-backend/issues/19) of the initial state

- [Current state](https://github.com/users/Paul-js-hub/projects/3)

- And we started as a team of 5 members but ended up with 3 members.

(back to top)


## 👥 Authors 

👤 **Paul Onchera**

- GitHub: [@paulonchera](https://github.com/Paul-js-hub)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/paul-onchera/)

👤 **Gordon Otieno**

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

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

👤 **Alphayo Wakarindi**

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

(back to top)


## 🔭 Future Features 

> Describe 1 - 3 features you will add to the project.

- [ ] **[new_feature_1]**

- [ ] **[new_feature_2]**

- [ ] **[new_feature_3]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

> Write a message to encourage readers to support your project

If you like this project...

(back to top)


## 🙏 Acknowledgments 

I would like to thank...

(back to top)


## ❓ FAQ (OPTIONAL) 

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Question_1]**

  - [Answer_1]

- **[Question_2]**

  - [Answer_2]

(back to top)


## 📝 License 

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

(back to top)