Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhanced Readme.md #198

Merged
merged 8 commits into from
Jul 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 83 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,59 @@
# Learn
![GSSoC Logo Light](https://user-images.githubusercontent.com/63473496/213306239-9e8fc317-ce2f-4127-8bfe-17f5df06ee99.png#gh-light-mode-only)
![GSSoC Logo Dark](https://user-images.githubusercontent.com/63473496/213306279-338f7ce9-9a9f-4427-8c2a-3e344874498f.png#gh-dark-mode-only)
<br>
<div align="center">

![IzzyOnDroid](https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/vdrs.sappu.lafk.learn) &nbsp;
[![made-with-flutter](https://img.shields.io/badge/Made%20with-Flutter-1f425f.svg)](https://flutter.dev/) &nbsp;
![Release](https://img.shields.io/github/v/release/VaibhavCodeClub/learn) &nbsp; ![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)
&nbsp;
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg) &nbsp;
<a href="https://github.com/VaibhavCodeClub/learn"><img src="https://sloc.xyz/github/VaibhavCodeClub/learn" alt="Lines of Code"/></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/stargazers"><img src="https://img.shields.io/github/stars/VaibhavCodeClub/learn" alt="Stars Badge"/></a>
&nbsp;<a href="https://github.com/VaibhavCodeClub/learn/network/members"><img src="https://img.shields.io/github/forks/VaibhavCodeClub/learn" alt="Forks Badge"/></a>
&nbsp; <br>
![GitHub contributors](https://img.shields.io/github/contributors/VaibhavCodeClub/learn?color=blue)
&nbsp;
![GitHub last commit](https://img.shields.io/github/last-commit/VaibhavCodeClub/learn?color=red&style=plastic)
&nbsp;
![Repo. Size](https://img.shields.io/github/repo-size/VaibhavCodeClub/learn?color=white)
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?v=103"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/issues"><img src="https://img.shields.io/github/issues/VaibhavCodeClub/learn?color=0059b3"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed-raw/VaibhavCodeClub/learn?color=yellow"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/pulls"><img src="https://img.shields.io/github/issues-pr/VaibhavCodeClub/learn?color=brightgreen"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed-raw/VaibhavCodeClub/learn?color=0059b3"></a>
&nbsp;
<center>
<img src="https://readme-typing-svg.herokuapp.com?color=45ffaa&size=40&width=900&height=80&lines=Welcome-to-Learn"/>
</center>

<div align="center">
<a href="https://android.izzysoft.de/repo/apk/vdrs.sappu.lafk.learn"> <img src='readme/IzzyOnDroid.png' width='150'/> </a>
<a href="https://github.com/VaibhavCodeClub/learn/releases"> <img src='readme/GitHub.png' width='150'/> </a> <br>
</div>
<br>

<a href="https://android.izzysoft.de/repo/apk/vdrs.sappu.lafk.learn"> <img src='readme/IzzyOnDroid.png' width='200'/> </a>
<a href="https://github.com/VaibhavCodeClub/learn/releases"> <img src='readme/GitHub.png' width='200'/> </a> <br>
</div>
Welcome to <strong>Learn</strong>, 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 :
<strong>Learn</strong>, 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!

## 🏆 Featured in:

<table>
<thead>
<tr>
<th>Event Logo</th>
<th>Event Name</th>
<th>Event Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><img src="readme/Gssoc Label.png" alt="GirlScript Summer of Code 2024 Logo"></td>
<td>GirlScript Summer of Code 2024</td>
<td>GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.</td>
</tr>
</tbody>
</table>

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [Contributing Guidelines](#contributing-guidelines)
- [Getting Started](#getting-started)
- [Clone the Git Repository](#clone-the-git-repository)
- [Run the Flutter Project](#run-the-flutter-project)
- [Screenshots](#screenshots)
- [License](#license)

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

## Contributing Guidelines

We believe in the power of collaboration. If you have ideas to improve College.ai, feel free to contribute! Check out our [Contribution Guidelines](CONTRIBUTING.md) to get started.


### Getting Started

To get started with the **Learn** app, follow these simple steps :
Expand Down Expand Up @@ -76,14 +86,11 @@ That's it! The app should now be running on your device/emulator.

**Note:** If you encounter any issues or have suggestions for improvement, please feel free to [create an issue](https://github.com/VaibhavCodeClub/learn/issues/new/choose) on our GitHub repository. We appreciate your feedback!

Made with ❤️ by [sapatevaibhav](https://github.com/sapatevaibhav).

Don't forget to star ⭐ the repository if you find it useful!
<!-- Hits since 10 May 2024 00:20 IST -->
![visitors](https://hits.sh/github.com/sapatevaibhav.learn/hits.svg)
## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
<br>


<h2 align = "center">Our Contributors ❤️</h2>
<div align = "center">
<h3>Thank you for contributing to our repository</h3>
Expand All @@ -92,6 +99,40 @@ Don't forget to star ⭐ the repository if you find it useful!


</div>
<br>

<div style="text-align: center;">
<p>Made with ❤️ by <a href="https://github.com/sapatevaibhav">sapatevaibhav</a>.</p>
</div>


Don't forget to star ⭐ the repository if you find it useful!
<!-- Hits since 10 May 2024 00:20 IST -->
![visitors](https://hits.sh/github.com/sapatevaibhav.learn/hits.svg)
![IzzyOnDroid](https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/vdrs.sappu.lafk.learn) &nbsp;
[![made-with-flutter](https://img.shields.io/badge/Made%20with-Flutter-1f425f.svg)](https://flutter.dev/) &nbsp;
![Release](https://img.shields.io/github/v/release/VaibhavCodeClub/learn) &nbsp; ![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)
&nbsp;
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg) &nbsp;
<a href="https://github.com/VaibhavCodeClub/learn"><img src="https://sloc.xyz/github/VaibhavCodeClub/learn" alt="Lines of Code"/></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/stargazers"><img src="https://img.shields.io/github/stars/VaibhavCodeClub/learn" alt="Stars Badge"/></a>
&nbsp;<a href="https://github.com/VaibhavCodeClub/learn/network/members"><img src="https://img.shields.io/github/forks/VaibhavCodeClub/learn" alt="Forks Badge"/></a>
&nbsp; <br>
![GitHub contributors](https://img.shields.io/github/contributors/VaibhavCodeClub/learn?color=blue)
&nbsp;
![GitHub last commit](https://img.shields.io/github/last-commit/VaibhavCodeClub/learn?color=red&style=plastic)
&nbsp;
![Repo. Size](https://img.shields.io/github/repo-size/VaibhavCodeClub/learn?color=white)
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?v=103"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/issues"><img src="https://img.shields.io/github/issues/VaibhavCodeClub/learn?color=0059b3"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed-raw/VaibhavCodeClub/learn?color=yellow"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/pulls"><img src="https://img.shields.io/github/issues-pr/VaibhavCodeClub/learn?color=brightgreen"></a>
&nbsp;
<a href="https://github.com/VaibhavCodeClub/learn/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed-raw/VaibhavCodeClub/learn?color=0059b3"></a>
&nbsp;

Binary file added readme/Gssoc Label.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.