Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psnappz/thesocialnetwork
A very basic Social Network App in DRF
https://github.com/psnappz/thesocialnetwork
Last synced: about 11 hours ago
JSON representation
A very basic Social Network App in DRF
- Host: GitHub
- URL: https://github.com/psnappz/thesocialnetwork
- Owner: PSNAppz
- Created: 2023-11-14T18:18:39.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2023-11-15T07:16:48.000Z (12 months ago)
- Last Synced: 2024-05-01T13:56:38.095Z (6 months ago)
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TheSocialNetwork
This is a Django REST Framework project implementing user authentication, friend request functionality, and custom throttling for certain endpoints.
## Postman Collection
[
](https://app.getpostman.com/run-collection/12298080-d0fb1fc3-e8a6-4e03-8970-e9ad198a877c?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D12298080-d0fb1fc3-e8a6-4e03-8970-e9ad198a877c%26entityType%3Dcollection%26workspaceId%3Db9068140-f88f-4d60-8b6c-3b1e4ac1a037)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
- Python 3.10
- pip
### Installing
A step-by-step series of examples that tell you how to get a development environment running:
1. **Clone the Repository**
```bash
git clone https://github.com/PSNAppz/TheSocialNetwork.git
cd TheSocialNetwork
```
2. **Set Up a Virtual Environment (Optional but Recommended)**
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. **Install Required Packages**
```bash
pip install -r requirements.txt
```
4. **Run Migrations**
```bash
python manage.py migrate
```
5. **Start the Development Server**
```bash
python manage.py runserver
```
6. **Access the API**
The API will be available at `http://localhost:8000`.
## Running with Docker (Optional)
If you prefer running the application in a Docker container, follow these steps:
1. **Build and Run with Docker Compose**
```bash
docker-compose up --build
```
2. **Access the Application**
The application will be accessible at `http://localhost:8000`.
## Built With
- Django
- Django REST Framework
## Database
- Sqlite (default)
- Postgres Config added (settings.py)
## Authors
- PS Narayanan