https://github.com/kayprogrammer/socialnet-v2
A Realtime Social Networking API built with Django Ninja
https://github.com/kayprogrammer/socialnet-v2
django django-ninja docker pgadmin postgresql
Last synced: 5 months ago
JSON representation
A Realtime Social Networking API built with Django Ninja
- Host: GitHub
- URL: https://github.com/kayprogrammer/socialnet-v2
- Owner: kayprogrammer
- License: mit
- Created: 2023-10-10T19:21:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T14:49:05.000Z (almost 2 years ago)
- Last Synced: 2024-04-16T02:22:27.035Z (over 1 year ago)
- Topics: django, django-ninja, docker, pgadmin, postgresql
- Language: Python
- Homepage:
- Size: 925 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SOCIALNET V2 | Social Networking API in Django Ninja Rest Framework
#### DJANGO DOCS: [Documentation](https://docs.djangoproject.com/en/4.2/)
#### DJANGO NINJA REST FRAMEWORK DOCS: [Documentation](https://django-ninja.dev/)
#### PG ADMIN: [Documentation](https://pgadmin.org)
## How to run locally
* Download this repo or run:
```bash
$ git clone git@github.com:kayprogrammer/socialnet-v2.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
$ python manage.py migrate
```
```bash
$ uvicorn socialnet.asgi:application --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
```
#### Swagger: [Documentation](https://swagger.io/docs/)
