https://github.com/developerwaleed/final-capstone-back-end
The repository contains the API for the front end project!
https://github.com/developerwaleed/final-capstone-back-end
Last synced: about 1 year ago
JSON representation
The repository contains the API for the front end project!
- Host: GitHub
- URL: https://github.com/developerwaleed/final-capstone-back-end
- Owner: developerwaleed
- Created: 2022-11-23T13:30:12.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-12-09T19:29:10.000Z (over 3 years ago)
- Last Synced: 2024-10-03T12:42:45.277Z (over 1 year ago)
- Language: Ruby
- Size: 668 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 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)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
- **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
Server
Database
### Key Features
- **Authenticated endpoints wit jwt**
- **User Authorization**
- **User Authentication with devise**
- [Live Demo Link](https://final-capstone-front-lfmdhnejp-developerwaleed.vercel.app/)
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:
```sh
rails s -p 3001
```
### Run tests
To run tests, run the following command:
```sh
rspec spec
```
### Deployment
You can deploy this project using:
- Heroku
| 👤 Name | Github | Twitter | LinkedIn |
|------|--------|---------|----------|
|Waleed Amjad|[@developerwaleed](https://github.com/developerwaleed)|[@developerwaleed](https://twitter.com/developerwaleed)|[@developerwaleed](https://www.linkedin.com/in/developerwaleed/)|
|Okoye Charles|[@Okoyecharles](https://github.com/OkoyeCharles)|[@Okoyecharles_](https://twitter.com/OkoyeCharles_)|[@Okoye Charles](https://www.linkedin.com/in/charles-k-okoye/)|
|Sidney Kaguli|[@xSidx](https://github.com/xSidx)|[@_sid_o](https://twitter.com/_sid_o)|[@sidney-kaguli](https://www.linkedin.com/in/sidney-kaguli/)|
|Priscilla Oyebade|[@OyePriscilla](https://github.com/OyePriscilla)|[@Prisicilla](https://twitter.com/Prisicilla)|[@Priscilla Oyebade](https://www.linkedin.com/in/priscilla-oyebade-aa35b8238/)|
|Abdulhamid|[Abdulhamid](https://github.com/abdulhamiid)|[@abdulhamid_adio](https://twitter.com/abdulhamid_adio)|[@Abdulhamid Adio](https://www.linkedin.com/in/abdulhamid-adio/)|
- Allow users to add their avatar.
- Create API endpoints to allow users to update their info.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project...
We would like to thank microverse for providing the curriculum to guide us on this project.
This project is [MIT](https://github.com/developerwaleed/final-capstone-back-end/blob/fixes/MIT.md) licensed.