Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sammyifelse authored Sep 24, 2024
1 parent fb451a7 commit 732367d
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## Getting Started

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

### Prerequisites

- Ruby (version 2.7 or later)
- Rails (version 6.0 or later)
- PostgreSQL
- Git

### Installation

1. Clone the repository:
```bash
git clone https://github.com/sammyifelse/Med-Care.git
2. Navigate to the project directory::
```bash
cd Med-Care
3. Install the required gems:
```bash
bundle install

4. Set up the database:
```bash
rails db:create
rails db:migrate
rails db:seed
5. Start the Rails server:
```bash
rails server
7. Open your browser and go to http://localhost:3000 to see the application in action.
```bash
This addition makes it clear that the user should navigate to the project directory after cloning the repository.
### Usage
Register a new user as a receptionist or doctor.
Log in and manage patient data.
View daily patient registration counts in the provided chart.
### Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements.
### License
This project is licensed under the MIT License - see the LICENSE file for details.
### Acknowledgements
Ruby on Rails - The web application framework used.
PostgreSQL - The database system used.
Bootstrap - For responsive design.
Chart.js - For data visualization in charts.

0 comments on commit 732367d

Please sign in to comment.