Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lbrian/broccoli-co
Broccoli & Co.
https://github.com/lbrian/broccoli-co
Last synced: 7 days ago
JSON representation
Broccoli & Co.
- Host: GitHub
- URL: https://github.com/lbrian/broccoli-co
- Owner: LBrian
- Created: 2023-03-10T12:06:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-03-10T23:16:07.000Z (over 1 year ago)
- Last Synced: 2024-10-23T23:57:20.790Z (21 days ago)
- Language: TypeScript
- Size: 483 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Broccoli & Co.
Request an invite page of Broccoli & Co. is powered by [Create React App](https://github.com/facebook/create-react-app). See the production page https://www.abc.com
## Tech stacks
- React
- Husky
- Eslint
- lint-staged
- Prettier
- Tailwind CSS
- Tailwind Plugin - daisyUI
- Typescript
- React-hook-form
- Jest (unit test)
- Playwright (e2e)
## Installation
The repo is scaffolded under Node `16.19.1` so ensure you have the right version to avoid package dependency errors during installation. You can simply install the right node version using `nvm`
```
nvm i 16
nvm use 16
```
```
node -v
v16.19.1
```
install `yarn`
```
npm i -g yarn
```
clone the repo
```
git clone [email protected]:LBrian/broccoli-co.git
```
install packages
```
cd broccoli-co
yarn
```
## Run the application locally
### `yarn start`
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
## Run unit test and e2e test
### `yarn test`
Launches the test runner `Jest` in the interactive watch mode.
### `yarn e2e`
Lunches `Playwright` e2e test and local web server to test against it. Test result will be output in the `playwright-report` folder.
## Build the production application
### `yarn run build`
Builds the app for production to the `build` folder.
## Work note
- 20 mins read through requirements and write test cases (TDD)
- 25 mins scaffolding
- 3.5 hrs implementation