GitHub - lachlanharrisdev/readme: A student productivity tool for scheduling when to read what you want to, versus what you need to

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 21 Commits
.github		.github
.vscode		.vscode
backend		backend
frontend		frontend
.gitignore		.gitignore
LICENSE		LICENSE
README		README
docker-compose.yml		docker-compose.yml

Repository files navigation

ReadMe
======

ReadMe is a student productivity tool for scheduling when to read the texts you want to, read versus the ones you need to.

`frontend/` contains the SvelteKit app for the frontend portion of the application.

`backend/` contains the Python app for the backend portion of the application.

The root of the monorepo (here) contains the relevant docker / docker-compose setup for running the application, as well as CI and repository configuration.

Links
-----

* GitHub Repository: https://github.com/lachlanharrisdev/readme
* Use the app: https://readme.lachlanharris.dev

Get Started
-----------

1) Clone the repository

+----
|    git clone https://github.com/lachlanharrisdev/readme
|    cd readme
+----

2) Using a text editor, update the appropriate environment variables in `docker-compose.yml`, including SECRET_KEY

3) Run the application

+----
|    docker compose up -d
+----

    The application will be reachable at `localhost:3000`

-------
This project is delivered under the Apache 2.0 License.

Copyright (c) 2026 Lachlan Harris. All Rights Reserved.