GitHub
972
Created 8 months ago, last commit 12 days ago
10 contributors
102 commits
Stars added on GitHub, month by month
N/A
N/A
N/A
N/A
N/A
N/A
N/A
10
11
12
1
2
3
4
5
6
7
8
9
2023
2024
Stars added on GitHub, per day, on average
Yesterday
=
Last week
+1.6
/day
Last month
+1.1
/day
Package on NPM
Monthly downloads on NPM
0
0
0
0
10
11
12
1
2
3
4
5
6
7
8
9
2023
2024
README

React Native Flash Calendar

npm npm runs with expo

This is the monorepo for Flash Calendar, an incredibly fast and flexible library to build calendars in React Native.

Documentation & Examples

You can find the Flash Calendar documentation on the website.

Installation

This project uses Bun as its package manager. The first thing you'll need is to install Bun.

To install dependencies, run at the root:

bun install

To build (required for a fresh install)

bun run build

To develop or run the example app:

bun dev

To run the documentation website:

bun docs

Contributing

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}.

Package structure

/apps

  • /apps/example: Storybook host for Flash Calendar, runs with the latest uncompiled code.
  • /apps/docs: The documentation website for Flash Calendar.

/kitchen-sink

A place to test the published Flash Calendar in a real environment.

  • /kitchen-sink/expo: Scaffolded expo project to test the flash calendar in a real environment.

/packages

The actual src code for Flash Calendar:

  • /packages/flash-calendar: The flash calendar package itself.
  • /packages/eslint-config: Shared eslint config for the project.
  • /packages/tsconfig: Shared tsconfig for the project.

License

Flash Calendar is MIT licensed.