A lightweight, mobile-friendly todo/action list.
Go to file
Andrew Lalis 1325916931 Improved auth redirection, and added PrintableListView.vue 2023-11-16 16:17:10 -05:00
design Added start of application. 2023-08-16 10:37:39 -04:00
litelist-api Updated handy-httpd dependency, added Clear Notes and Print this list buttons, improved button spacing. 2023-11-16 15:29:36 -05:00
litelist-app Improved auth redirection, and added PrintableListView.vue 2023-11-16 16:17:10 -05:00
LICENSE Initial commit 2023-08-16 09:01:40 -04:00
README.md Improved readme, added gitignore. 2023-08-22 08:09:45 -04:00
deploy.sh Added deployment script. 2023-08-18 10:37:52 -04:00
litelist-api.service Added deployment script. 2023-08-18 10:37:52 -04:00

README.md

LiteList

A lightweight, mobile-friendly todo/action list, built using Vue 3 in the front-end, and D / Handy-Httpd in the back-end.

App

The web application is a simple Vue 3 application, using the vue router and typescript, but few, if any, additional dependencies. The app is designed to be easy to use and accessible for mobile device users, instead of having to deploy a separate app for various devices.

The app starts with a basic login page, then directs authenticated users to a /lists page showing all of their lists. You can click on a list to view any notes that have been added to that list.

Run the app:

cd litelist-app
npm install
npm run dev

API

The back-end API is a simple HTTP server built using Handy-Httpd. It handles authentication, as well as the actual application data.

Run the API:

cd litelist-api
dub run

Authentication

Users are authenticated by sending their credentials (username and password) and receiving a JWT access token that's valid for a short time period. Users can renew their access token if they still have a valid one, but once it expires, they'll need to log in again.

Data

Application data is stored in a users/ directory, relative to the litelist-api application's working directory. Inside users/, there's a directory for each username. Within each username directory, you'll find a user.json file with the user's information, as well as notes.sqlite, which is the SQLite3 database storing the user's notes.

Building and Deploying

Because I deploy this application to litelist.andrewlalis.com, I've included a script deploy.sh and SystemD unit file litelist-api.service for convenience. If you're deploying somewhere else, you'll need to tweak those two files a bit.

Also note that in deploy.sh when building the API, I use a locally-referenced LDC2 compiler for D instead of the default DMD. This helps to improve performance, but leads to longer build times.