james-hernandez-tl / final-aa-project

KnowVerse

KnowVerse is a quizlet clone where users have full CRUD on sets and folders. They can create and use these sets to study.

check out KnowVerse

Index

MVP Feature List | Database Scheme | User Stories | Wire Frames

Technologies Used

Getting started

1. Clone this repository: https://github.com/ihavenoide/final-aa-project.git

2. Install denpendencies into the Backed and the Frontend by making a terminal for each one and then run the following:

   • backend (In base of directory):
     • Pipenv install
   • frontend :
     • npm install

3. Create a .env file using the .envexample provided

4. Set up your database with information from your .env and then run the following to create your database, migrate, and seed (base directory):

   • Pipenv shell
   • flask db init
   • flask db migrate
   • flask db upgrade
   • flask seed all

5. Start the app for both backend and frontend using:

   • backend :
     • flask run
   • fontend :
     • npm start

Amazon Web Services S3

• For setting up your AWS refer to this guide

Home Page

Home.page.recording.mov

Sets

set.recording.mov

Folders

Folder.recording.mov

Features

Sets

• Users can create a set
• Users can read/view other Sets
• Users can update their Sets
• Users can delete their Sets
• Users can rate Sets on a scale of 1-5

Folders

• Users can create a Folder
• Users can read/view their own Folders
• Users can update their Folders
• Users can delete their Folders

Search

• In the nav bar users can search for public Sets filtered by name/description
• When viewing their own Sets Users can filtered by name/description
• When viewing their own Folders Users can filtered by name/description

Future Features

• Search for Users
• Follow other Users
• Ai chat to help users study sets
• Achievements to track users progress