Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evanssnave/final-capstone-project-back-end
@Doc is an application that'll allow users to register and create medical appointments or if they desire they can also reserve doctors. There are options so that users can add or delete a doctor. In a doctor's details page information relevant to appointments and reservations will be displayed.
https://github.com/evanssnave/final-capstone-project-back-end
api backend collaboration database postgresql rubocop ruby ruby-on-rails sql
Last synced: 4 months ago
JSON representation
@Doc is an application that'll allow users to register and create medical appointments or if they desire they can also reserve doctors. There are options so that users can add or delete a doctor. In a doctor's details page information relevant to appointments and reservations will be displayed.
- Host: GitHub
- URL: https://github.com/evanssnave/final-capstone-project-back-end
- Owner: EvansSnave
- License: mit
- Created: 2024-01-24T18:38:19.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-02-11T15:15:58.000Z (12 months ago)
- Last Synced: 2024-05-17T16:04:34.852Z (9 months ago)
- Topics: api, backend, collaboration, database, postgresql, rubocop, ruby, ruby-on-rails, sql
- Language: Ruby
- Homepage:
- Size: 19.1 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 final\_capstone\_back\_end ](#-final_capstone_back_end-)
- [🛠 ER Diagram ](#-er-diagram-)
- [💻 link to front end ](#-link-to-front-end-)
- [💻 link to Kanban board information ](#-link-to-kanban-board-information-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database Setup](#database-setup)
- [Usage](#usage)
- [💻 Tests ](#tests-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
**final_capstone_back_end** The back-end component of this final capstone project is developed using Ruby on Rails, configured to serve as an API. This API is designed to facilitate medical appointments, and to allow users to make reservations for doctors. It leverages a PostgreSQL database to manage and store reservation data. The API is designed to be consumed by a front-end application, which is developed using React.js.
Model diagram
[Link to Front End](https://github.com/EvansSnave/final-capstone-project-front-end)
## 💻 link to Kanban board information
[Link to Kanban Board](https://github.com/EvansSnave/final-capstone-project-back-end/projects/1)
[Initial state](https://github.com/EvansSnave/final-capstone-project-front-end/issues/17)
This project was completed by two Team members:
- Kevin Cruz
- Fisayo Michael
Technologies
Linters
- Rubocop
- **Ruby on Rails**
- **API Endpoint**
- **Professional Documentation**
- **Linting for Code Quality**
- **Postgres Database**
- **Git Version Control**
To get a local copy up and running, follow these steps:
### Prerequisites
Before you begin, ensure you have the following prerequisites installed on your system:
- Ruby: You need Ruby to run the Ruby on Rails application.
- Bundler: Bundler is used to manage gem dependencies for your Ruby project.
### Setup
In your terminal, navigate to the folder of your choice and clone the repository with the following commands:
```sh
cd my-folder
git https://github.com/EvansSnave/final-capstone-project-back-end.git
```
### Install
After cloning the project, change into the project directory:
```sh
cd final_capstone_project_back_end
```
Install this project with:
- gem install rails
- bundle install
### Credentials setup
In order to create databases and run the tests, you need to follow this steps:
1. Remove config/master.key and config/credentials.yml.enc if they exist.
2. Run `rails secret`. This will generate a key. Copy and reserve the key to use later.
3. If you use Windows run: `$env:EDITOR="code --wait"; rails credentials:edit` If you use Linux run: `EDITOR="code --wait" bin/rails credentials:edit`
4. Your editor will open a file, add at the bottom `devise_jwt_secret_key: `
5. Save the file and close the editor. New master.key, credentials.yml.enc files will be generated, and the key will be stored in `Rails.application.credentials.devise_jwt_secret_key`.
### Database Setup
Create and migrate your database with:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails server
or
rails s
```
This should start your local server on http://localhost:3000/. Now, you can use the REST API client of your choice to interact with the API.
To run tests, navigate to the directory where the project is located on your machine, open your terminal, and follow these steps:
Test Suite
This project contains a suite of unit tests which you can run to ensure everything is functioning as expected. To run these tests, you need RSpec installed.
To install RSpec if you haven't already, run:
gem install rspec
After you've installed RSpec, you can run the tests with:
bundle exec rspec spec/controllers
bundle exec rspec spec/models
👤 **EvanSnave**
- GitHub: [EvansSnave](https://github.com/EvansSnave)
- Twitter: [Kroja13](https://twitter.com/Kroja13)
- LinkedIn: [Kevin Cruz](https://www.linkedin.com/in/kevin-cruz-25159a201/)
- [ ] **Implement proper user authentication from the front-end to the server**
- [ ] **Add authorizations to users**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/EvansSnave/final-capstone-project-back-end/issues).
If you like this project please feel free to send us corrections for make it better we would feel glad to read your comments.
And think If you enjoy it gift us a star.
- Behance and Murat Korkmaz for the [original design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign)
- Microverse for providing the opportunity to learn in a collaborative environment.
- React.js Documentation for valuable resources on React development.
- GitHub for version control and collaboration tools.
- **Can I use with a templeate your project?**
- Of course we would feel honored.
- **Your project is free license?**
- Yeah, you can use it completely.
This project is licensed under the MIT License - you can click here to have more details [MIT](./LICENSE).