Skip to content

Latest commit

 

History

History
146 lines (103 loc) · 6.77 KB

learn.md

File metadata and controls

146 lines (103 loc) · 6.77 KB
Raw

Table of Contents

  1. What is the repo all about?
  2. What is the solution trying to solve?
  3. Contributing Guidelines 📄
  4. Need some help regarding the basics? 🤔
  5. Alternatively Contribute Using GitHub Desktop
  6. Issue Report Process 📌
  7. Pull Request Process 🚀
  8. To Whom Should I Reach Out?
  9. Tech Stack Used
  10. How to Set Up on a Local System

What is the repo all about?

Learn is a simple learning app built using Flutter for kids. This app is designed to provide an engaging learning experience for children, covering a wide range of topics including:

  • A-Z Alphabets with examples and pronunciation.
  • Animals and their pronunciation along with their voices.
  • Body parts and their pronunciation with short information on various topics.
  • More exciting features are planned for future updates, such as birds and their voices, information on the solar system, knowledge of shapes, and much more!

What is the solution trying to solve?

For children aged 2-5 years old, the app addresses the need for basic knowledge of their surroundings. Teachers often have to search for images and information individually, but this app provides a single, comprehensive resource where all images and categories are available in one place. Categories include:

  • A-Z
  • Birds
  • Body parts
  • Shapes
  • Solar system
  • Animals

In addition to learning, the app offers quizzes and a speaking feature to help children learn how to pronounce various objects.

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all contributions from anyone willing to improve or add new scripts to this project. Thank you for helping out, and remember, no contribution is too small.

Please note that we have a Code of Conduct which we ask you to follow in all your interactions with the project.

Need some help regarding the basics? 🤔

You can refer to the following articles on the basics of Git and GitHub, and also contact the Project Mentors if you are stuck:

Alternatively Contribute Using GitHub Desktop

  1. Open GitHub Desktop:

    • Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, click on the "File" menu and select "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, click on the "Current Branch" dropdown menu and select the desired branch.

  4. Make Changes:

    • Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to" button to commit your changes to the local branch.

  6. Push Changes to GitHub:

    • After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

    • Go to the GitHub website and navigate to your fork of the repository.
    • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  8. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  9. Wait for Review:

    • Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.

Issue Report Process 📌

  1. Go to the project's issues.
  2. Provide a proper description for the issue.
  3. Avoid spamming to get the assignment of the issue 😀.
  4. Wait until someone is looking into it.
  5. Start working on the issue only after you are assigned to it 🚀.

Pull Request Process 🚀

  1. Ensure that you have self-reviewed your code 😀.
  2. Make sure you have added a proper description for the functionality of the code.
  3. Comment your code, particularly in hard-to-understand areas.
  4. Add screenshots to help in the review.
  5. Submit your PR by providing the necessary information in the PR template and hang tight; we will review it really soon 🚀.

To Whom Should I Reach Out?

For inquiries, you can reach out to:

Tech Stack Used

  • Dart
  • C++
  • CMake
  • Swift
  • HTML
  • C
  • Flutter

How to Set Up on a Local System

  1. Open GitHub Desktop:

    • Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, click on the "File" menu and select "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Download Flutter:

    • Ensure you have Flutter installed. If not, follow the instructions on Flutter.dev to get it installed on your machine.

  4. Navigate to the Project Directory:

    • Use the terminal to navigate to the project directory.

  5. Fetch Dependencies:

    • Run the following command to fetch the dependencies: bash flutter pub get

  6. Run the App:

    • Once the dependencies are fetched, run the app on your preferred device using: bash flutter run

That's it! The app should now be running on your device/emulator.