https://github.com/kayprogrammer/socialnet-v5
A Social Networking API built with Litestar and Tortoise ORM
https://github.com/kayprogrammer/socialnet-v5
litestar litestar-framework pgadmin4 postgresql tortoise-orm
Last synced: about 1 month ago
JSON representation
A Social Networking API built with Litestar and Tortoise ORM
- Host: GitHub
- URL: https://github.com/kayprogrammer/socialnet-v5
- Owner: kayprogrammer
- License: mit
- Created: 2024-02-16T16:32:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-14T11:05:09.000Z (about 1 year ago)
- Last Synced: 2025-01-29T15:21:52.350Z (3 months ago)
- Topics: litestar, litestar-framework, pgadmin4, postgresql, tortoise-orm
- Language: Python
- Homepage:
- Size: 818 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SOCIALNET V5
A Realtime Social Networking API built with Litestar and Tortoise ORM
#### LITESTAR DOCS: [Documentation](https://docs.litestar.dev/latest/)
#### TORTOISE ORM DOCS: [Documentation](https://tortoise.github.io/index.html)
#### PG ADMIN: [Documentation](https://pgadmin.org)
## How to run locally
* Download this repo or run:
```bash
$ git clone [email protected]:kayprogrammer/socialnet-V5.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
$ aerich init-db
```
```bash
$ aerich mig
```
```bash
$ litestar run --reload --debug
```
- 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
```
