a-qxin/Omlet

hierarchical flashcards + gamified studying!

Omlet

A flashcard study app built by students for students.

Table of Contents

• About the Project
  • Design Process
  • Built With
• Getting Started
• Acknowledgements

About The Project

Omlet is a desktop flashcard study app built by students for students.

Our team of four (2 designers, 2 devs) came together via BuildConnect to design a web app that allows students to study more efficiently with a clean user experience + to have the option to organize flashcards in a hierarchical format.

This is an ongoing project.

Design Process

See our team's process doc here.

Built With

• React
• MongoDB
• Node.js
• Mongoose
• React Bootstrap
• Express
• SwaggerUI

Getting Started

To clone a local copy of this repository, use:

git clone https://github.com/a-qxin/omelette/

To run our app, we use the following:

frontend (port 8080):

npm i 

npm start

To run the backend (port 4000) alongside the frontend, also use:

# Run the backend server
cd backend
npm i
npm start

# Then, on a new terminal, navigate to the root directory of the repo
# and run the frontend with the following:
npm run start:fake

Acknowledgements

• BuildConnect
• Jason Watmore's tutorials