https://github.com/kayprogrammer/norebase-challenge
A simple API demonstrating likes feature built in FastAPI
https://github.com/kayprogrammer/norebase-challenge
fastapi likes likes-count postgresql pytest sqlalchemy
Last synced: 19 days ago
JSON representation
A simple API demonstrating likes feature built in FastAPI
- Host: GitHub
- URL: https://github.com/kayprogrammer/norebase-challenge
- Owner: kayprogrammer
- Created: 2024-10-29T18:19:17.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-02T21:01:13.000Z (6 months ago)
- Last Synced: 2025-02-13T16:19:19.915Z (2 months ago)
- Topics: fastapi, likes, likes-count, postgresql, pytest, sqlalchemy
- Language: Python
- Homepage: https://norebase-challenge.fly.dev
- Size: 98.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NOREBASE CHALLENGE API
## How to run locally
* Download this repo or run:
```bash
$ git clone [email protected]:kayprogrammer/norebase-challenge.git
```
#### In the root directory:
- Install all dependencies
```bash
$ pip install -r requirements.txt
```
- Create an `.env` file and copy the contents from the `.env.example` to the file and set the respective values. A postgres database can be created with PG ADMIN or psql
- Run Locally
```bash
$ alembic upgrade heads
```
```bash
$ uvicorn app.main:app --reload
```
- Run With Docker
```bash
$ docker-compose up --build -d --remove-orphans
```
OR
```bash
$ make build
```
- Test Coverage
```bash
$ pytest --disable-warnings -vv
```
OR
```bash
$ make test
```
#### LIVE URL [NOREBASE Challenge Documentation](https://norebase-challenge.fly.dev)