noodle README

The project's README from github.com/noodle-run/noodle. As one markdown file: README.md.

Noodle logo

Noodle
Rethinking Student Productivity


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 for updates.

Noodle Preview

⚠️ This is a UI design mockup of what the platform will look like, it is not the current state of the project.

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

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

Future Features

Feel free to suggest more features by opening an issue, or join our Discord server to discuss it with the community.

Star History

Star History Chart Star History Chart

Contributing

If you would like to contribute to Noodle, please read the CONTRIBUTING.md file to get started.

License

Noodle is open source and available under the AGPL-3.0-or-later license.

noodle (noodle-run/noodle)

Searching Database…

12.2K ·GitHub
archived
这是什么?Noodle 是一款计划中的学生一站式效率网页应用,旨在取代同时使用多个应用来管理笔记、记忆卡、日历、任务和成绩的麻烦,让所有功能集中在一个工具里。
它只是一个笔记应用,还是功能更多?笔记和自动生成的记忆卡测验是首批 MVP 功能;更长远的规划是打造完整的学生效率套件,并在此基础上加入日历、任务管理和成绩跟踪。
我该如何在本地运行它?README 中没有安装指南,但代码库是一个 Next.js/Bun 项目:运行 bun install 安装依赖,使用 drizzle-kit 的 db:migrate 脚本设置数据库,然后用 next build 进行构建。
它依赖哪些后端服务?该技术栈与 Clerk(身份验证)、通过 Drizzle ORM 连接的 Neon(Postgres)或 Turso(SQLite)数据库,以及用于缓存的 Upstash Redis 相连,因此要运行它,你需要注册这些服务的账户。
这个应用现在可以直接使用吗?不可以。README 明确提醒,截图只是计划中平台的界面原型,并非当前的实际状态;该项目最初是一个开发中的早期 MVP,之后代码仓库被归档。
除了笔记和记忆卡,Noodle 还计划增加哪些功能?路线图包括日历、任务管理和成绩跟踪,将在最初的笔记和自动生成记忆卡 MVP 基础上逐步扩展。
Noodle 还在积极开发吗?不了。GitHub 仓库已被归档,README 早已将该项目标注为开发中的早期 MVP,之后开发便停止了。
作者为什么要自己做 Noodle,而不用现成的学生应用?作者在大学期间深受同时使用多个独立应用之苦,想要一个能涵盖学生所需一切的单一工具,类似 GitHub 将开发者的工作集中在一处的思路。
Creator
noodle-run
Size
14.1 MB
Stars
12.2K
Updated
CommitOct 17
Age
4y
Commits · 90 Days