QuEstCe le Quizz

Quickly generate memory flashcards to better learn and review knowledge.

📚 Table of Contents

Test It Now
Installation
Customize
Database structure
Contributing
License

📢 Test It Now

Go to the demo here.
Then enjoy !

🚀 Installation

Fork the project
Clone it
Install dependencies npm install
Start the project npm start

🎨 Customize

1️⃣ Create a firebase project

Create a firebase project with a web application and a realtime database (if you don't how follow the official steps)

2️⃣ Link the local firebase config to your firebase app

On the setting of your firebase web application copy and past your firebase config into static/config.js file

3️⃣ Create your content

Edit the static/database.json file and respect the data structure explained bellow

4️⃣ Upload your database

Upload your data to your realtime database

5️⃣ The enjoy !

Run npm start
Go to http://localhost:3000/?id=demo (id=... refers to the name of the key you've given to your topic in static/database.json, note that if you don't provide any id all topics will be fetched)

git clone https://github.com/lucasmrdt/edt-to-google-calendar
cd edt-to-google-calendar
pip install -r requirements.txt --user

🏗 Database structure

See static/database.json

key	type
topic name (eg. `"demo"`)	List<ICard>

ICard

key	required	type	example	description
question	✅	`string`	`"my question"`	Enter your question here, past some url picture to embed a picture and write latex with $x = \\pi$
answer	✅	`string`	`"my answer"`	Enter your answer here, past some url picture to embed a picture and write latex with $x = \\pi$
un_reversible	❌	`bool`	`false`	Set to `true` if your question is a one way question

💌 Contributing

Fell free to enhance the project by adding some new / more customable features.

☎️ Support

Reach out to me at one of the following places!

Website at lucas-marandat.fr
LinkedIn at @lucasmrdt

📝 License

MIT license

lucasmrdt / questce-le-quizz Goto Github PK

questce-le-quizz's Introduction