Skip to content
This repository was archived by the owner on Jun 5, 2019. It is now read-only.

Commit 40a1e69

Browse files
committed
Updates the docs
1 parent 994a498 commit 40a1e69

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

docs/using.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Ready to start your project?
1818
I'm still deciding on a simple way, but there will be a script you can run.
1919

2020
```sh
21-
npm run time-to-shine
21+
# this does exist yet
22+
npm run time-to-shine
2223
```
2324

2425

@@ -37,9 +38,44 @@ If you want to just remove the examples and continue with the app layout:
3738
* delete `src/renderer/features/example-using-tabs`
3839
* remove corresponding lines from `src/renderer/index.ts`
3940
* remove the same from `src/renderer/app/app.tsx`
41+
* remove the `src/shared/models`
42+
* remove the `src/main/database`
4043

4144
Now you're ready to start adding your own features.
4245

46+
## Testing
47+
48+
There's a script that does everything.
49+
50+
```sh
51+
npm run sanity
52+
```
53+
54+
It'll:
55+
56+
* clean up an temp files or build artifacts
57+
* compile & check your typescript for errors
58+
* lint both typescript and javascript for issues
59+
* run the tests
60+
* clean again
61+
* compile the app in production mode
62+
* clean 1 last time.
63+
64+
This is hooked up to a `pre-push` build script. This will help you not check in mistakes. Trust me.
65+
66+
If you want to run in `watch` mode for testing while you develop (quite nice!):
67+
68+
```sh
69+
# in terminal 1:
70+
npm run watch:compile
71+
72+
# in terminal 2:
73+
npm run watch:tests
74+
```
75+
76+
Now when you edit your files, it'll recompile & re-run the relevant tests on the fly. And it's quick!
77+
78+
4379

4480
## Building
4581

0 commit comments

Comments
 (0)