https://github.com/ttiimmothy/flashcard-application

A flashcard application connects to ChatGPT 3.5 to generate different flashcards according to the topics you type
https://github.com/ttiimmothy/flashcard-application

openai react react-router redux-toolkit tailwindcss typescript vite

Last synced: about 2 months ago
JSON representation

A flashcard application connects to ChatGPT 3.5 to generate different flashcards according to the topics you type

• Host: GitHub
• URL: https://github.com/ttiimmothy/flashcard-application
• Owner: ttiimmothy
• License: gpl-3.0
• Created: 2023-11-01T23:00:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-16T00:46:58.000Z (about 1 year ago)
• Last Synced: 2024-04-24T03:00:41.531Z (9 months ago)
• Topics: openai, react, react-router, redux-toolkit, tailwindcss, typescript, vite
• Language: TypeScript
• Homepage: https://flashcardapplication.vercel.app
• Size: 211 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Flashcard Application

[![ci](https://github.com/ttiimmothy/flashcard-application/actions/workflows/ci.yml/badge.svg)](https://github.com/ttiimmothy/flashcard-application/actions/workflows/ci.yml)

[![cd](https://github.com/ttiimmothy/flashcard-application/actions/workflows/cd.yml/badge.svg)](https://github.com/ttiimmothy/flashcard-application/actions/workflows/cd.yml)

A flashcard application uses `Typescript`, `React` amd `Vite`. It uses `Tailwind CSS` for simplifying CSS usage. The application uses `react-router` to navigate between pages and `@reduxjs/toolkit` to perform state management. It also connects to `OpenAI ChatGPT 3.5` api to generate the flashcards.

## 🎯 Features

- generate flashcards according to the topic that user type

- flip the flashcards to show the questions and answers

## 🖥 Prerequisites

- Node.js (version 12.0 or above)

- npm (which comes with Node.js) or Yarn (version 1.22.0 or above)

## 🔧 Usage

### Build packages and Run

```TypeScript

npm install

npm run dev

```

## :scroll: Environment Variables

#### details see the `.env.example` files

- `OpenAI` api key

If you use `github pages` for static page deployment, you need to set these environmental variables in github action`secrets`.

## License

Flashcard Application is licensed under [GNU General Public License v3.0](LICENSE).