One-to-Ten

One-To-Ten, a project inspired by OKCupid, is a platform that allows users to take surveys and match with other users based on response data.

Index

Feature List - DB Schema - API Documentation - Frontend Routes

Technologies Used

Launching Locally

Prerequisites

- Python 3.10
- PostgreSQL 12s

Getting Started

1. Clone the project repository

   • git clone git@github.com:JTannerShaw/One-to-Ten.git

2. Install Dependencies

• Flask:

  • pipenv install --dev -r dev-requirements.txt && pipenv install -r requirements.txt

• React-App:

  • npm install

3. Create a .env file base on the .env.example given in the root directory

FLASK_APP=app
FLASK_ENV=development
SECRET_KEY=<you strong secret key>
DATABASE_URL=postgresql://<username>:<password>@<server>/<database>

4. Setup your username and database based on what you setup in your .env

5. Migrate and seed the database by intiating the pipenv shell from the root directory.

   • pipenv shell
   • flask db upgrade
   • flask seed all

6. Start the server from the root directory.

   • flask run

7. Start the frontend from the react-app directory.

   • flask run

Site Preview

New users can register for an account by entering a unique email address, a username, a secure password, and by verifying they are over 18 years of age.

Existing users can log in to their account by submitting their credentials via the login form.

Logged in users can end their session by clicking the log out button.

Users may log in with an pre-existing demo user account by clicking the link on the login page.

Logged-in users can activate their account my taking the icebreaker survey which initiaties automatic match generation.

Activated users can answer questions in order to improve their compatibility with other users.

Activated users can view and amend their previous responses by clicking the respective survey button.

Activated users can delete their previous responses to a given question by toggling the 'Deletion Mode' text on the 'Answer Questions' page, and clicking the 'X' button next to the survey they wish to delete.

Activated users may view their matches with other users, which will display their compatibility score, their most- and least-similar topics, their biography, and their social media links.

Logged-in users can edit their profile information and preview what their page will look like when other users are viewing their match profile.

Activated users can change their compatibility scores with other users by completing additional surveys.

Activated users can remove matches by blocking another user.

Activated users can remove all matches and survey responses by deactivating their profile.

Contributors