stepus53/writer
1
0
Fork 0
mirror of https://github.com/usatiuk/writer.git synced 2025-10-29 00:17:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Stepan Usatiuk
2019-12-21 14:00:08 +03:00
committed by GitHub
parent 3f91e190f6
commit dfe7402fae
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,5 +1,5 @@
# writer
A simple web/markdown-based notebook thingy
A simple web/markdown-based note taking app
![screenshot](docs/main.png)
@@ -7,8 +7,10 @@ This is a notebook app written in typescript using koa for the backend and react
## 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)
First, install all of the dependencies with `npm i` and `cd frontend && npm i`
Then start with `npm run dev`
You also need to create a ormconfig.json and ormconfig.test.json (only if you want to run the tests). You can use ormconfig.example.json as an example (you only need to change the database connection settings)
Then start with `npm run dev` and visit http://localhost:1234
Parcel will be listening at http://localhost:1234, and koa at http://localhost:3000