abdulhamiid/final-capstone-back-end

The repository contains the API for the front end project! GymFit. Built with Ruby on rails

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 GymFit

• GymFit is a web application that allows users to view and reserve a fitness activity, i.e. Yoga class, Gym e.t.c. A user can reserve multiple fitness activities and a fitness activity can have multiple reservations on separate dates.
• The application features user based authorization, a basic user can read and manage their user specific reservations while the admin can manage all operations in the application. I.e. create and delete fitness_activities e.t.c

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Authenticated endpoints wit jwt
• User Authorization
• User Authentication with devise

(back to top)

🚀 Live Demo

• Live Demo Link

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

• Ruby runtime environment
• Postgresql
• Rails

Setup

Clone this repository to your desired folder:

Install

Install this project with:

• Clone the repository using git@github.com:XsidX/final-capstone-back-end.git
• Navigate to the folder using cd final-capstone-back-end
• Use the following commands to
  • install necessary gems bundle install
  • create database rails db:create
  • run migrations and create default user as admin rails db:migrate db:seed

Usage

To run the project, execute the following command:

 rails s -p 3001

Run tests

To run tests, run the following command:

rspec spec

Deployment

You can deploy this project using:

• Heroku

(back to top)

👥 Authors

👤 Name	Github	Twitter	LinkedIn
Waleed Amjad	@developerwaleed	@developerwaleed	@developerwaleed
Okoye Charles	@Okoyecharles	@Okoyecharles_	@Okoye Charles
Sidney Kaguli	@xSidx	@_sid_o	@sidney-kaguli
Priscilla Oyebade	@OyePriscilla	@Prisicilla	@Priscilla Oyebade
Abdulhamid	Abdulhamid	@abdulhamid_adio	@Abdulhamid Adio

🔭 Future Features

• Allow users to add their avatar.
• Create API endpoints to allow users to update their info.

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

(back to top)

🙏 Acknowledgments

We would like to thank microverse for providing the curriculum to guide us on this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)