Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kayprogrammer/socialnet-v1
A Realtime Social networking API built with django rest framework
https://github.com/kayprogrammer/socialnet-v1
django django-channels django-rest-framework docker pgadmin4 postgresql
Last synced: 21 days ago
JSON representation
A Realtime Social networking API built with django rest framework
- Host: GitHub
- URL: https://github.com/kayprogrammer/socialnet-v1
- Owner: kayprogrammer
- License: mit
- Created: 2023-07-15T17:33:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T21:49:37.000Z (5 months ago)
- Last Synced: 2024-07-25T00:46:37.018Z (5 months ago)
- Topics: django, django-channels, django-rest-framework, docker, pgadmin4, postgresql
- Language: Python
- Homepage: https://socialnet-drf.vercel.app
- Size: 1.87 MB
- Stars: 14
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SOCIALNET V1
#### DJANGO DOCS: [Documentation](https://docs.djangoproject.com/en/4.2/)
#### DJANGO REST FRAMEWORK DOCS: [Documentation](https://www.django-rest-framework.org/)
#### PG ADMIN: [Documentation](https://pgadmin.org)
## How to run locally
* Download this repo or run:
```bash
$ git clone [email protected]:kayprogrammer/socialnet-v1.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
```
## Docs
#### Swagger: [Documentation](https://swagger.io/docs/)
