WikipStudy

Learn with the power of Wikipedia, made interactive and fun!
WikipStudy transforms Wikipedia's wealth of knowledge into engaging quizzes. Perfect for students, educators, and lifelong learners!

---

⚠️ Note: This repository is no longer maintained.

WikipStudy was a school project and is not actively developed. The README was part of the requirements of the exercise to create a realistic project page. However, every functionality listed here was really implemented in the app !

---

Overview

• 📚 Create quizzes effortlessly from Wikipedia articles.
• 🧠 Test your knowledge or challenge others with shared quizzes.
• ⭐ Bookmark your favorite quizzes for quick access.
• 🔒 Prioritize privacy—your data remains secure.

---

Application Idea and Target Audience

What the Project Does

WikipStudy allows users to create their quizzes with questions and fill-in answers. Users can:

• Generate quizzes from Wikipedia articles by extracting sentences and replacing key terms with blanks.
• Explore quizzes created by others, adding their favorites for future access.

Target Audience

• Students: Ideal for high school or university exam preparation.
• Teachers: A valuable tool to create custom quizzes for enhanced participation.
• Lifelong Learners: Explore and learn across diverse topics with ease.

---

Application Functionalities

• 🎮 Play: Answer questions and see your score.
• ✍️ Create: Design custom quizzes with unique images.
• 🤖 Generate: Auto-create quizzes using Wikipedia articles.
• 🔍 Search: Find and try quizzes made by others.
• ⭐ Bookmarking: Save your favorite quizzes for easy access.
• 🔒 Privacy Matters: Your email address is safe and private.

---

Screenshots

Login Page

Create a Quiz

---

Deploy Your Instance

To deploy WikipStudy locally and start using the application, follow these steps:

1. Clone all repositories:

   git clone https://github.com/arkonny/WikipStudy
   git clone https://github.com/arkonny/WikipStudy-Backend
   git clone https://github.com/arkonny/WikipStudy-Auth
   git clone https://github.com/arkonny/WikipStudy-Upload

2. Install the dependencies for each repository (except the front-end):

   cd WikipStudy-Backend
   npm install
   cd ../WikipStudy-Auth
   npm install
   cd ../WikipStudy-Upload
   npm install

3. Configure .env files with:

   • MongoDB credentials
   • JWT secret (use the same across repositories)
   • Admin password (currently used for testing only).

4. Start each application:

   npm run dev

5. Launch the front-end with a live server (e.g., VSCode Live Server).

6. Access the Apollo server interface at http://localhost:3000/graphql.

Notes

• GraphQL server links are hard-coded in the front-end:
  • GraphQL: src/graphql/graphqlCall.js (line 2).
  • Upload Server: src/js/utils.js (line 122).

---

Contributing

Contributions to WikipStudy are welcome! The project is currently a proof-of-concept, and front-end development is not the primary focus. However, the following areas are priorities:

Next Priorities

• Question Variety: Include multimedia options (audio, images, videos).
• Advanced Question Types: Introduce true/false, multiple-choice, and more.
• Enhanced Generation: Automate diverse question types from written text.
• New Interfaces: Consider stand-alone apps or Discord bot integrations.

---

License

This project is licensed under the MIT License.