From b307b0a72782fcec8ce2908d6ce4d51fb5ff2728 Mon Sep 17 00:00:00 2001 From: Stepan Usatiuk Date: Sun, 27 Oct 2019 13:41:45 +0300 Subject: [PATCH] Create README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..dda3208 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# writer +A simple web/markdown-based notebook thingy + +This is a notebook app written in typescript using koa for the backend and react+redux for the frontend. + +## Getting started + +You need to create a ormconfig.json file, you can use ormconfig.example.json as, well, an example (you only need to change the database connection settings) + +Then start with `npm run dev` + +Parcel will be listening at http://localhost:1234, and koa at http://localhost:3000