Table of Contents
Friender is a geolocation-based social media app for finding and chatting with friends near you. Each user sets their location, and a radius within which they can search for friends.
If two users indicate they'd like to be friends with each other, they match, and can began chatting with each other.
This API can be used in conjunction with the Friender frontend, or queried directly using tools such as Insomnia or Postman.
To get a local version of Friender up and running, do the following. Note that, to have an operational Friender frontend, you will need to set up the backend as well.
-
Clone the repo
git clone https://github.com/danjzych/friender-backend.git
-
Create and Start Virtual Environment
python -m venv venv source venv/bin/activate
-
Install Requirements in Virtual Environment
pip3 install -r reqquirements.txt
-
Create postgresQL Database and Seed Data
ipython [1] %run app.py [2] %run seed.py
-
Setup AWS S3 Bucket for user photos Friender uses S3 object storage to store and access user photos. Create an S3 bucket with CORS enabled.
-
Add AWS Credentials to .env You will need:
'AWS_ACCESS_KEY_ID'
'AWS_SECRET_ACCESS_KEY'
'IMAGE_BUCKET'
-
Upload user images from
/images
to your S3 bucket and ensure the file names match those used inseed.py
.
After doing the above, you are ready to launch the Friender backend. From your virtual environment, run
flask run -p 5001
- Add Profile Photo Designation for user images
- Optimize searching for potential friends
- Add notifications system
- Track whether new matches and messages have been seen by relevant users
- Refactor chatting using Flask websockets
See the open issues for a full list of proposed features (and known issues).
Distributed under the MIT License.
Daniel Zych - LinkedIn - danjzych@gmail.com
Project Link: https://github.com/danjzych/friender-backend
This project was also built with: