You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can find the Flash Calendar documentation [on the website](https://marceloprado.github.io/flash-calendar/).
12
+
13
+
## Installation
10
14
11
15
This project uses [Bun](https://bun.sh/) as its package manager. The first thing you'll need is to [install Bun](https://bun.sh/).
12
16
@@ -34,27 +38,32 @@ To run the documentation website:
34
38
bun docs
35
39
```
36
40
37
-
### Making changes
41
+
##Contributing
38
42
39
-
Ensure your chagens are unit-tested. To improve DX, run the tests in watch mode with `bun test --watch`. You can also run the tests for a specific file with `bun test --watch {filename}`.
43
+
Ensure your changes are unit-tested. To improve DX, run the tests in watch mode with `bun test --watch`. You can also run the tests for a specific file with `bun test --watch {filename}`.
40
44
41
-
####Package structure
45
+
### Package structure
42
46
43
-
#####/apps
47
+
#### /apps
44
48
45
49
-`/apps/example`: Storybook host for Flash Calendar, runs with the latest uncompiled code.
46
50
-`/apps/docs`: The documentation website for Flash Calendar.
47
51
48
-
#####/kitchen-sink
52
+
#### /kitchen-sink
49
53
50
54
A place to test the published Flash Calendar in a real environment.
51
55
52
56
-`/kitchen-sink/expo`: Scaffolded expo project to test the flash calendar in a real environment.
53
57
54
-
#####/packages
58
+
#### /packages
55
59
56
60
The actual src code for Flash Calendar:
57
61
58
62
-`/packages/flash-calendar`: The flash calendar package itself.
59
63
-`/packages/eslint-config`: Shared eslint config for the project.
60
64
-`/packages/tsconfig`: Shared tsconfig for the project.
0 commit comments