https://github.com/geekelo/fenaj-schedula_api
An API built to manage appointment bookings
https://github.com/geekelo/fenaj-schedula_api
api-only backend-api postgressql ruby-on-rails
Last synced: about 1 year ago
JSON representation
An API built to manage appointment bookings
- Host: GitHub
- URL: https://github.com/geekelo/fenaj-schedula_api
- Owner: geekelo
- License: mit
- Created: 2023-11-29T07:25:59.000Z (over 2 years ago)
- Default Branch: development
- Last Pushed: 2023-12-18T15:48:15.000Z (over 2 years ago)
- Last Synced: 2025-03-29T04:41:37.532Z (about 1 year ago)
- Topics: api-only, backend-api, postgressql, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 438 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> The Fenaj Schedula API allows users to create an account, book a new session and can reserve the session.
### Frontend Repository
[Fenaj Schedula Front End](https://github.com/geekelo/fenaj-schedula)
### Api Documentation
API DOCUMENTATION - domain/api-docs
## Kanban Board:
[Kanban-board](https://github.com/users/geekelo/projects/3)
[Initial board state](https://github.com/geekelo/fenaj-schedula_API/issues/25)
## Team:
We are a 5-member team.
- Ruby
- Ruby on Rails
- Postgres SQL
- [x] Create a user based on the role
- [x] Create a session and view all sessions
- [x] Create reservations and view all reservations
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Command line or terminal
- IDE such as VsCode.
- Rails needs to be installed on your system.
### Setup
Clone this repository to your desired folder:
Example command:
```sh
git clone git@github.com:geekelo/fenaj-schedula_API.git
```
### Install
Example command:
```sh
cd fenaj-schedula_API
bundle install (install all dependencies)
rails db:create (to create database)
rails db:migrate (to migrate tables)
```
### Usage
To run the project, run the following command:
```sh
rails s -p 30001
```
👤 **Nasir Mahmood**
- GitHub: [Nasirkhan294](https://github.com/Nasirkhan294)
- LinkedIn: [nasirmahd](https://www.linkedin.com/in/nasirmahd/)
👤 **Eloghene Otiede**
- GitHub: [@geekelo](https://github.com/geekelo)
- LinkedIn: [eloghene-otiede](https://www.linkedin.com/in/eloghene-otiede-b146a3232/)
👤 **Fatima Najafi**
- GitHub: [@fatima-najafi](https://github.com/fatima-najafi)
- LinkedIn: [fatima-najafi](https://www.linkedin.com/in/fatima-najafi/)
👤 **Joyce Cruz**
- GitHub: [@balastar](https://github.com/balatstar)
- LinkedIn: [joyce-ann-cruz](https://www.linkedin.com/in/joyce-ann-cruz-668a41a7/)
👤 **Adeyemi Dada**
- GitHub: [@yemidada](https://github.com/yemidada)
- LinkedIn: [yemidada](https://www.linkedin.com/in/yemidada/)
- [ ] add comments
- [ ] add likes
- [ ] error deduction for sessions
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Please support this project and be a part of something meaningful and impactful. Your contribution can make a significant difference and help us achieve our goals faster.
I would like to express my sincere gratitude to [Murat Korkmaz](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign) for this design and to all my Microverse partners who contributed to this project.
- **Can I fork and reuse this repository?**
Absolutely! Please feel free to fork and reuse this repository for your own projects.
- **Is it okay to improve this repository? Will my changes be accepted?**
Definitely! We welcome any improvements or new ideas you may have. If your changes are good and align with the project's goals, we would be happy to accept them.
This project is [MIT](./LICENSE) licensed.