Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/tugsem/huzurevi_backend


https://github.com/tugsem/huzurevi_backend

Last synced: 5 days ago
JSON representation

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)
- [πŸ‘₯ Authors](#authors)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ“ License](#license)

# πŸ“– [Huzurevi Backend]

> API-only rails app for a nursing home application including admin and user (nurses) authentication, and a stock management page for the business, the features are admin panel, patient panel, and stock panel. Nurses will use the patient panel to record the medications given to the patient.

## πŸ›  Built With

### Tech Stack

Client

Server

Database

### Key Features
Admin Panel:
- Display a stock chart and business stats on the dashboard
- Add, update and remove stock on the stock panel

Employee Panel:
- Display a list of patients
- Create a new record of the given medication and necessary notes about the patient

(back to top)

## πŸš€ Live Demo

- [Rails Server](https://huzurevibackend-production.up.railway.app/)

(back to top)

## πŸ’» Getting Started

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

### Prerequisites

In order to run this project you need:
- Ruby
- Rails

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone [email protected]/tugsem/huzurevi_backend.git
```

### Install

Install this project with:

```sh
cd huzurevi_backend
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails db:create
rails db:migrate
rails start
```

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Tuğsem SaranlΔ±**

- GitHub: [@githubhandle](https://github.com/tugsem)
- Twitter: [@twitterhandle](https://twitter.com/tugsemSaranli)
- LinkedIn: [LinkedIn](https://linkedin.com/in/tugsem)

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project give a star!

(back to top)

## πŸ“ License

This project is [MIT](./LICENSE) licensed.

(back to top)