UniLife

This repo is an REST API for "UniLife" mobile app. UniLife mobile app is a blog app where users can share about their memories at university.

Overview

The main features that have currently been implemented are:

• Read posts(no need to login)
• Create / Update / Delete the post.
• Like / Save / Comment the post
• Authentication and Authorization(oject-level)
• Token Authentication
• User Profile
• Follow / Unfollow
• Search posts

Tech Stack

Backend - Django REST Framework
Database - Postgres
Hosting - AWS Lambda, AWS S3 Bucket, AWS RDS

Demo

The endpoint used in production is priavate. However, you can test on this mock server

Entity–relationship Diagram

Note: Click and download the image to see details. ![Entity–relationship model](https://github.com/pyaephyokyaw15/UniLife/blob/main/ERD.png]

Quick Start

To get this project up and running locally on your computer:

1. Clone the project.

   git clone [https://github.com/pyaephyokyaw15/UniLife.git]

2. Set up the Python development environment.

   Note: I want to recommend using a Python virtual environment.

3. Create .env file in the project root directory and create variables used in settings.py.

4. Assuming you have Python setup, run the following commands (if you're on Windows you may use py or py -3 instead of python to start Python):

   pip3 install -r requirements.txt
   python3 manage.py makemigrations
   python3 manage.py migrate
   python3 manage.py collectstatic
   python3 manage.py test # Run the standard tests. These should all pass.
   python3 manage.py createsuperuser # Create a superuser
   python3 manage.py runserver
   

5. Open a browser to http://127.0.0.1:8000.

6. Admin Site: http://127.0.0.1:8000/admin

References

• Django Documentation
• Django REST Framework
• drf-yasg

Author

• @pyaephyokyaw15