https://github.com/developerwaleed/deploy-backend-test
Try Deploy!
https://github.com/developerwaleed/deploy-backend-test
Last synced: about 1 year ago
JSON representation
Try Deploy!
- Host: GitHub
- URL: https://github.com/developerwaleed/deploy-backend-test
- Owner: developerwaleed
- Created: 2022-12-08T17:11:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T17:33:07.000Z (over 3 years ago)
- Last Synced: 2024-10-03T12:42:56.510Z (over 1 year ago)
- Language: Ruby
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- 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 will be available soon](https://yourdeployedapplicationlink.com)
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
👤 **Sidney**
- GitHub: [XsidX](https://github.com/XsidX)
- Twitter: [@\_sid_o](https://twitter.com/_sid_o_)
- LinkedIn: [Sidney Kaguli](https://www.linkedin.com/in/sidney-kaguli)
👤 **Abdulhamid**
- GitHub: [abdulhamiid](https://github.com/abdulhamiid)
- Twitter: [@abdulhamid_adio](https://twitter.com/abdulhamid_adio)
- LinkedIn: [Adio Abdulhamid](www.linkedin.com/in/abdulhamid-adio)
### 👤 **Charles**
- GitHub: [Okoye Charles](https://github.com/OkoyeCharles)
- LinkedIn: [Okoye Charles](https://www.linkedin.com/in/charles-k-okoye/)
- Twitter: [@Okoyecharles_](https://twitter.com/OkoyeCharles_)
### 👤 **Waleed**
- GitHub: [Waleed Amjad](https://github.com/developerwaleed)
- LinkedIn: [Waleed Amjad](https://www.linkedin.com/in/developerwaleed/)
- Twitter: [@developerwaleed](https://twitter.com/developerwaleed)
### 👤 **Priscilla**
- GitHub: [Priscilla Oyebade](https://github.com/OyePriscilla)
- LinkedIn: [Priscilla Oyebade](https://www.linkedin.com/in/priscilla-oyebade-aa35b8238/)
- Twitter: [@Prisicilla](https://twitter.com/Prisicilla)
- 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.