Skip to content

Commit

Permalink
docs(project): update the documentation (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
fffjacquier authored Mar 3, 2022
1 parent 64aa174 commit 7a4007c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
## Code of Conduct

This project and everyone participating in it is governed by the
[BedrockStreaming Forms Code of Conduct](https://github.com/BedrockStreaming/formsblob/master/CODE_OF_CONDUCT.md).
[BedrockStreaming Forms Code of Conduct](https://github.com/BedrockStreaming/forms/blob/master/.github/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <[email protected]>.

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,19 @@ First read the [Contributing](.github/CONTRIBUTING.md) and [Code of conduct](.gi

:point_up: Note that this project was generated using [Nx](https://nx.dev).

### Getting started

Check each library's documentation.

To test each library development, we'll use the demo app and the docsite (dog-fooding strategy).

This project handles 4 libraries packages, which are used in two apps: demo and docsite (e2e apps are simply holding test code about those apps)
The `demo` project is there to smoothe the dev experience
The `docsite` project is the one used on https://bedrockstreaming.github.io/forms/

In order to start on the project, you can start with the demo project:
`yarn start demo`

### Generate an application

Run `yarn nx g @nrwl/react:app my-app` to generate an application.
Expand Down

0 comments on commit 7a4007c

Please sign in to comment.