Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mgautam98/fastapi-hpd


https://github.com/mgautam98/fastapi-hpd

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# Healthcare Provider Directory APP

Individual parts of projects are on follwing branches
`part_1`
`part_2`
`part_3`

## Generate mock data

```
mkdir database
python generate_data.py # generates 300 records in pickle format
```

## Structure

```
├── app # fastapi app
│   ├── __init__.py #
│   ├── core #
│   │   ├── config.py # setting and configurations
│   │   ├── dataimp.py # file database implimentation
│   │   ├── exceptions.py # exceptions used
│   │   └── utils.py # utils
│   ├── database.py # database
│   ├── repository #
│   │   └─ provider.py # providers data access
│   ├── routers #
│   │   └── provider.py # providers routes
│   ├── schemas.py # pydantic schemas
│   └── main.py # entry to fastapi app
└── generate_data.py # mock data generator
```

## Run Locally

Clone the project

```bash
git clone https://github.com/mgautam98/fastapi-hpd.git
```

Go to the project directory

```bash
cd fastapi-hpd
```

Install dependencies, requires `poetry`

```bash
poetry install
```

Start the server

```bash
uvicorn app.main:app --reload
```

## Deployment

To deploy this project run

```bash
docker-compose up
```

## Running Tests

To run tests, run the following command

```bash
pytest
```

## Environment Variables

To run this project, you will need to add the following environment variables to your .env file

`POSTGRES_URL`
`POSTGRES_USER`
`POSTGRES_PW`

## Screenshots


Mailsy
Mailsy
Mailsy
Mailsy