benji6 / webnotes

:spiral_notepad: A serverless and offline-first PWA that helps you manage your notes

Home Page:https://webnotes.link

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Webnotes

CI Netlify Status

About

Webnotes is a free and open source web app that lets you create and manage notes. It's simple to use, works offline and because it runs in your browser you can use it across all your devices!

Check it out here

The Webnotes UI was built using a component library I made called Eri.

Getting started

Install dependencies

make init

Test

make test

Run

make start

Deploy

Backend and infrastructure

Majority of the infrastructure is managed with Terraform (a few things that aren't well supported have been done manually).

make deploy

N.B. making changes to the API doesn't trigger a new deployment, but you can trigger a manual deployment by copying the deploy_api_command Terraform output and running that.

UI

Continuously deployed with Netlify.

N.B. because icons take a long time to generate and do not change often they are created from the master svg file by running npm run icons in the /client dir and committed to version control.

Acknowledgements

  • Teddy for user acceptance testing
  • All the awesome open source software used by this project

About

:spiral_notepad: A serverless and offline-first PWA that helps you manage your notes

https://webnotes.link

License:MIT License


Languages

Language:TypeScript 77.0%Language:HCL 13.5%Language:JavaScript 3.4%Language:Python 1.6%Language:HTML 1.6%Language:Shell 1.4%Language:CSS 0.9%Language:Makefile 0.6%