Study Buddies is a web application that allows users to create, study, and quiz themselves on flashcards.
- Getting Started
- Prerequisites
- Downloading The Project
- Setting Up The Front End
- Running The Project
- Built With
- Authors
- Contributors
- Similar Projects
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
In order to run this project, you need to have Node.js installed. To tell if you have it installed, open your Command Line/Terminal and type the following:
$ node -v
v10.x.x
To begin setting up the project, either download the project by clicking here or by cloning the project:
$ git clone https://github.com/m1771vw/StudyBuddies
$ cd StudyBuddies
Navigate to the root of the project folder and run npm install:
$ npm install
After the dependencies have been installed, you can start the project.
To run the project, you will need to be in the StudyBuddies directory.
Run npm start.
To confirm the frontend has started, you should be greeted with this screen.
To login, first make an account by pressing the Sign Up button in the top right corner of the header, or the Sign up for free button on the home page.
After making an account, it should re-direct you to the login page.
If you logged in successfully, you will be re-directed to the dashboard. You should see some pre-seeded data on the dashboard.
You can press on the white + cardset to create a new cardset. Add the title of the cardset, description, and the card terms and definitions as necessary. If you are adding more than 4, you can press the + to add more rows. Once you're finished, pressed Submit Set.
After creating a cardset, it will redirect you to the cardset details page.
Here, you can study the cards by hovering over them to see the definition to the term.
You can press the Quiz button to quiz yourself on your cards.
You can look here for a list of contributors for the project.