Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/braincee/doctors-appointment-back-end

Microverse Final Group Capstone Project: A Doctor Appointments' web app where registered users can book an appointment based on their preference and intended usage. This project is the back-end part of the final capstone project from Microverse. It is built built using Ruby on Rails..
https://github.com/braincee/doctors-appointment-back-end

microverse-projects microverse-students postgresql rspec-testing rubocop-rails ruby ruby-gem ruby-on-rails

Last synced: about 14 hours ago
JSON representation

Microverse Final Group Capstone Project: A Doctor Appointments' web app where registered users can book an appointment based on their preference and intended usage. This project is the back-end part of the final capstone project from Microverse. It is built built using Ruby on Rails..

Awesome Lists containing this project

README

        

# Doctor Appointment App

> A mobile web application where a user can check all available doctors adn therir details. Book an appointment and have a list of all appointments that he/she made. User can also delete an appointment.

Project requirements can be found [here](https://github.com/microverseinc/curriculum-final-capstone/blob/main/projects/business_requirements.md)

## Kanban Board
We are two members in team
- [@braincee](https://github.com/braincee)
- [@ridaarif98](https://github.com/Bria22)

Link to the project: [Kanban Board](https://github.com/users/braincee/projects/10)

Screenshot of the initial Stage

('./Screenshot (10).png')

## Documentation
Follow this [link](http://localhost:3001/api-docs/index.html) to see documentation of SWAGGER API.

## Built With

- Ruby
- Ruby on Rails
- CSS
- PostgreSQL

## Getting Started

To get a local copy up and running follow these simple example steps.

### Setup

- Clone the repository

`git clone https://github.com/braincee/doctors-appointment-back-end.git `

- Navigate to the folder
-
`cd Blog-application`

### Prerequisites

- Ruby
- Ruby on Rails
- CSS
- Bootstrap

### Install

Run in the terminal to install the gems:

`bundle install`

### Usage

To run the Rails server, in the terminal:

`rails server`

### Testing with RSpec

- To install rspec: gem install rspec
- To test: rspec
- To test specific folder: rspec spec/requests
- To test specific file: rspec spec/requests/filename_spec.rb

### Testing with Capybara

- To install rspec: gem install rspec
- To test: rspec
- To test specific folder: rspec spec/integration
- To test specific file: rspec spec/integration/filename_spec.rb

### SWAGGER API

- TO install: gem rswag
- To generate: rails generate rspec:install
- To generate swagger JSON file: rake rswag:specs:swaggerize

## Author

👤 **Stephen Annor**

- GitHub: [braincee](https://github.com/braincee)
- Twitter: [annor0543](https://twitter.com/annor0543)
- LinkedIn: [Stephen Annor](https://www.linkedin.com/stephen-annor)

👤 **Brian Nyachae**

- GitHub: [braincee](https://github.com/Bria22)
- Twitter: [Bria22](https://twitter.com/Bria22)
- LinkedIn: [Brian Nyachae](https://www.linkedin.com/in/brian-nyachae/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/braincee/doctors-appointment-back-end/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments
- [Microverse](https://www.microverse.org/)
- Original design idea by [Murat Korkmaz on Behance](https://www.behance.net/muratk).
- [FontAwesome](https://fontawesome.com/) and [Flaticon](https://www.flaticon.com/) for icons.
- [Unsplash](https://unsplash.com/) for images.

## 📝 License
This project is MIT licensed.