Skip to content

zaskier/flashcard-content-generator

Repository files navigation

Nest Logo

#nestjs #openAI #GCP #Firestore #Cloud Sotrage #CSV

Description

Generator for flashcard content made with OpenAi For generating cards you can post csv file using postman, required file format is is using 3 columns :

  • subject

  • topic

  • text_explanation

    from this file aplicaton generates csv report file which is uploaded to cloud storage bucket describeed in .env file with added statuses of generation adn logging failure statuses and their reason. Content of cards generated by OpenAI is added to firtore database. There is CRUD API for files and for cards.

Installation

$ npm install

Add .env file

according to .env.development in ain directory

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

Running the app locally with Firebase using firestore emulator

first follow instruction https://firebase.google.com/docs/cli

# development
$ firebase emulators:start
$ npm run start

# watch mode
$ npm run start:dev

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

About

openai powered flashcards generator using csv files as input and uploading content to firestore

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors