# noodle

**Repository Path**: caoyangjie/noodle

## Basic Information

- **Project Name**: noodle
- **Description**: No description available
- **Primary Language**: NodeJS
- **License**: AGPL-3.0
- **Default Branch**: ahmed/modules
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-08-15
- **Last Updated**: 2024-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img src="https://github.com/noodle-run/noodle/blob/main/public/logo.svg?raw=true" alt="Noodle logo" width="75">
  <h1>Noodle <br> Rethinking Student Productivity</h1>
  <br>
</div>

> **Warning**
> This is a work-in-progress and not the finished product.
>
> Noodle is still in active development towards a minimal viable product (MVP).
>
> Follow me on twitter [@ixahmedxii](https://twitter.com/ixahmedxii) for updates.

![Noodle Preview](https://github.com/noodle-run/noodle/blob/main/public/_static/dark-dashboard-preview.jpg?raw=true)

<p align="center" style="color:dodgerblue;"><strong>⚠️ This is a UI design mockup of what the platform will look like, it is not the current state of the project.</strong></p>

## Purpose

Noodle as an idea came from the struggles that I faced during my university years. I was using multiple apps to try and stay on track with my studies, and I thought to myself, why is there no singular app that can do everything a student needs to stay on track with their studies? Like a GitHub but for students.

## Planned MVP Features

- ✍️ Note Taking
- 📚 Flashcards

The flashcards will be generated from the notes that you take, and you will be able to quiz yourself on them.

## Future Features

- 📅 Calendar
- 📝 Task management
- 📊 Grade tracking

Feel free to suggest more features by opening an issue, or join our [Discord server](https://discord.gg/ewKmQd8kYm) to discuss it with the community.

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=noodle-run/noodle#gh-light-mode-only)](https://star-history.com/#noodle-run/noodle#gh-light-mode-only)
[![Star History Chart](https://api.star-history.com/svg?repos=noodle-run/noodle&theme=dark#gh-dark-mode-only)](https://star-history.com/#noodle-run/noodle#gh-dark-mode-only)

## Contributing

If you would like to contribute to Noodle, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file to get started.

## License

Noodle is open source and available under the [AGPL-3.0-or-later](./LICENSE) license.