Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kayprogrammer/socialnet-v3
A Realtime Social Networking API built with FastAPI and Piccolo ORM
https://github.com/kayprogrammer/socialnet-v3
argon2 fastapi jwt pgadmin4 piccolo postgresql
Last synced: 8 days ago
JSON representation
A Realtime Social Networking API built with FastAPI and Piccolo ORM
- Host: GitHub
- URL: https://github.com/kayprogrammer/socialnet-v3
- Owner: kayprogrammer
- License: mit
- Created: 2023-12-28T21:43:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-08T14:49:30.000Z (11 months ago)
- Last Synced: 2024-12-01T19:13:51.665Z (2 months ago)
- Topics: argon2, fastapi, jwt, pgadmin4, piccolo, postgresql
- Language: Python
- Homepage:
- Size: 1.01 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SOCIALNET V3
#### FASTAPI DOCS: [Documentation](https://fastapi.tiangolo.com/)
#### PICCOLO DOCS: [Documentation](https://piccolo-orm.readthedocs.io/)
#### PG ADMIN: [Documentation](https://pgadmin.org)
## How to run locally
* Download this repo or run:
```bash
$ git clone [email protected]:kayprogrammer/socialnet-v3.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 --debug --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
```
