https://github.com/terror/proust
A learning tool
https://github.com/terror/proust
Last synced: 10 months ago
JSON representation
A learning tool
- Host: GitHub
- URL: https://github.com/terror/proust
- Owner: terror
- License: cc0-1.0
- Created: 2024-07-06T03:44:31.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-19T16:45:06.000Z (over 1 year ago)
- Last Synced: 2025-03-05T23:08:44.246Z (10 months ago)
- Language: TypeScript
- Homepage: https://proust.cloud
- Size: 286 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
## proust
**proust** is a tool to help you learn more from static content.
> [!WARNING]
> This project is in very early stages. Breaking changes guaranteed.
It runs fully client-side and in the browser.
We abstract out the notion of a *workspace*, a place where you can load in static content from disk or from the web, having it fully indexed and ready to be interacted with.
As of now the only supported media types are PDF documents.
### Development
I'm solely using [React](https://react.dev/) and [TypeScript](https://www.typescriptlang.org/) to build this application.
To get started contributing, first install dependencies:
```bash
bun install
```
...then startup the development server:
```bash
bun run dev
```
Check out `.env.example` for what environment variables need to be set.
Expect `http://localhost:5173/` to be in use and the app ready to view in a web browser.
## Prior Art
Got inspiration to work on this project from the book [Brave New Words: How AI Will Revolutionize Education](https://www.amazon.ca/Brave-New-Words-Revolutionize-Education/dp/0593656954) written by Salman Khan.