Social Media app with basic authentication and friend request feature.
List of key features provided by Social Media App.
- Users can login with their email and password (email should be case insensitive).
- Users can signup with their email only (no OTP verification required, valid email format is sufficient).
- User can serch other Users (using exact email or part of username)
- send/accept/reject friend requests.
- list friends (list of users who have accepted friend request)
- List pending friend requests (received friend request).
- Users cannot send more than 3 friend requests within a minute.
- Python (>= 3.10)
- Django (>= 5.0.4)
- Django Rest Framework (>= 3.15.1)
Other dependency can be found in requirements.txt
Instructions for setting up and Social Media App. It include both the setup with and without Docker.
-
Clone the repository:
git clone git@github.com:vis7/social_media_app.git cd social_media_app -
Install dependencies:
sudo apt install python3-virtualenv virtualenv venv source venv/bin/activate pip install -r requirements.txt -
Add .env file along with below settings and add it parallel to settins.py:
SECRET_KEY='django-insecure-7sxch!f7g%nuf^yrvz5&1fl32++w!8o1*3cu3t8+hl+$z)e=)c' DEBUG=True -
Apply migrations:
python manage.py migrate
-
Run the development server:
python manage.py runserver
-
Clone the repository:
git clone git@github.com:vis7/social_media_app.git cd social_media_app -
Add .env file along with below settings and add it parallel to settins.py:
SECRET_KEY='django-insecure-7sxch!f7g%nuf^yrvz5&1fl32++w!8o1*3cu3t8+hl+$z)e=)c' DEBUG=True -
Build the Docker image:
docker build -t social_media_app . -
Run the Docker container:
docker run -p 8000:8000 social_media_app
-
You can also run above using docker compose up:
docker compose up --build -d
Import Postman Collection and Enviornment from postman folder. Now you are ready to run APIs.
MIT License