https://github.com/andrewmcdan/cleverdecks
Intro to SWE Group 4 Project - CleverDecks flash cards study system
https://github.com/andrewmcdan/cleverdecks
flashcards student-project study studying
Last synced: 2 months ago
JSON representation
Intro to SWE Group 4 Project - CleverDecks flash cards study system
- Host: GitHub
- URL: https://github.com/andrewmcdan/cleverdecks
- Owner: andrewmcdan
- License: agpl-3.0
- Created: 2024-02-11T00:29:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-27T18:29:37.000Z (12 months ago)
- Last Synced: 2024-12-31T08:21:46.505Z (4 months ago)
- Topics: flashcards, student-project, study, studying
- Language: JavaScript
- Homepage:
- Size: 691 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CleverDecks
A modern flash card system that allows students to create flashcards using AI assistance (ChatGPT) and use this system to study flash cards using a novel progressive delivery system that allows for incremental learning of the content. The interface is web based and allows access from any device, while the backend is a locally run application that the user runs on their computer. This allows the user to save their flashcards on their computer or anywhere else.
## CleverDecks Launcher
See [andrewmcdan/CleverDecksLauncher](https://github.com/andrewmcdan/CleverDecksLauncher) for a launcher for this little project of ours.
## TODO's (in no particular order)
1. Complete each of the support classes in the /index.js file.
2. Finish all the server endpoint code.
3. ChatGPT interfacing and related classes
4. Work on the various web pages. Pages to work on:
- /web/index.html - The main landing page. Probably needs to include something to let the user know if ChatGPT is enabled and let them add their OpenAI API key if needed.
- /web/create.html - A page for creating flash cards. Need to include functions for using ChatGPT to generate cards as well as manually creating cards.
- /web/study.html - The flash card study page.
- /web/quiz.html - The quiz page.
# Getting Started
To get this project running on your machine for development:
1. Install [node.js and npm](https://nodejs.org/en/download).
2. Clone this repo (in the command prompt or powershell)
```
git clone https://github.com/andrewmcdan/CleverDecks.git
```
3. cd into the repo and npm install it
```
cd CleverDecks
npm i
```
4. At this point, you can run it as is with "npm start" but to have ChatGPT work immediately, create a .env file with the following line in it:
```
OPENAI_SECRET_KEY=your-api-key
```
5. Run it (from the command prompt / powershell)
```
npm start
```
6. Point your browser at http://localhost:3000/ if it doesn't automatically open
## Running Tests
This is pretty easy, just run 'npm test' at the command prompt. All the tests defined in the tests folder will be executed.
To run one set of tests, like, the tests for the chatGPT class, run 'npm test chatGPT'. It searches for filenames in the tests folder that match, so chatGPT matches 'tests/chatGPT.test.js'.
## Run the binary
If you just want to run it, download the precompiled binary (if it is available), run it, and point your browser to http://localhost:3000/ (if it doesn't automatically open)
Note: The binaries may be out of date.