Skip to content

Commit

Permalink
docs: adjust readme commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Emanuel Suriano committed Oct 14, 2022
1 parent 579f4dc commit 6d45423
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,28 +143,38 @@ const App = () => (
| `children` | `ReactNode` | false | null | Section content |
| `id` | `string` | true | - | Section ID |

## Contributing
## Contributing 🧑‍💼

### Setup project
I'm always open for suggestions and improvements, so don't hesitate to open an Issue or new Pull Request.

- Running `yarn install` in the component's root directory will install everything you need for development.
### Setup project

### Demo Development Server
This project is using Yarn workspace, therefore check that you have Yarn as your package manager.

- `yarn start`: starts the development server with the component's demo app at [http://localhost:3000](http://localhost:3000).
```sh
# Check if you have you Yarn install
> yarn -v
1.22.18

### Testing
# Install dependencies
> yarn
```

- `yarn test`: executes Cypress and run test. Remember to execute `yarn start` in order to have a successful result.
- `yarn test:open`: opens Cypress interface which allows you to execute test individually and preview the order execution of the tests.
### Commands

### Building
```sh
# Builds library
> yarn build

- `yarn build`: builds the library, this is necessary to be published to npm.
# Starts demo app locally
> yarn start

## Contribute ❤️
# Run E2E tests
> yarn test

I'm always open for suggestions and improvements, so don't hesitate to open an Issue or new Pull Request 😁
# Build library + demo app
> yarn build:demo
```

## License 🔖

Expand Down

0 comments on commit 6d45423

Please sign in to comment.