Skip to content

Home

Jump to bottom
Daniel Odicho edited this page Nov 5, 2023 · 1 revision

Edventure App Wiki

Welcome to the Edventure App Wiki! This resource is designed to guide you through the features, setup, and development of the Edventure app, a platform for personalized learning experiences.

Getting Started

  • Introduction: Edventure is a web-based learning platform built with Flask, offering personalized learning experiences. Users can register to track their progress and preferences, engage with educational content, and connect with the community.
  • Installation: To get started with Edventure:
    • Clone the repository from GitHub.
    • Install Flask and Flask-SQLAlchemy.
    • Run flask run to start the development server.

How-To Guides

  • User Registration: New users can register through the main page. The user's username, email, and preferences are captured to customize their learning journey.
  • Setting Up a Local Database: The app uses SQLite for local development. To initialize the database, use the Flask context to create tables with db.create_all().

Reference

  • API Documentation: Currently, Edventure provides a minimalistic RESTful API to interact with user data. Endpoints will be detailed as the API expands.
  • Database Schema: The User model contains id, username, and email. A Preferences model may be added to store user preferences for personalized experiences.

Contribute

  • Contributing Guide: Contributions to Edventure are welcome! Please fork the repository, make your changes, and submit a pull request.
  • Code of Conduct: We strive for an inclusive and respectful community. All contributions must adhere to our code of conduct, which emphasizes respect and courtesy.

Support

  • FAQ: Common questions about user accounts, data privacy, and feature requests.
  • Troubleshooting: Guidance on common setup issues and how to resolve them.

Community

  • Events: Information on Edventure webinars, community calls, and educational events.
  • Discussions: Our GitHub Discussions page is a place for the community to ask questions, share ideas, and help each other make the most of Edventure.

For any new sections or specific information you'd like to see in this Wiki, please start a discussion or open an issue in the repository, and we'll work on updating the documentation accordingly.

Clone this wiki locally