Skip to content

Commit

Permalink
TASK: Enhance the documentation and contribution guides
Browse files Browse the repository at this point in the history
  • Loading branch information
Inkdpixels committed Dec 3, 2017
1 parent 68d6f20 commit f620fcf
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 12 deletions.
33 changes: 22 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,46 @@ Before opening an issue, please make sure that your issue hasn't been already re
Visit the [issue tracker](https://github.com/ImmoweltGroup/create-react-microservice/issues) to find a list of open issues that are easy to pick up or need some love.

Fork, then clone the repo:
```
```sh
git clone https://github.com/your-username/create-react-microservice.git
cd create-react-microservice
yarn install
yarn run bootstrap
```

### Building
Running the `build` task will transpile the code and move all flow annotations into separate files.
```
npm run build
Running the `build` task will re-build the CLI.
```sh
yarn run build
```

### Testing, Type-Checking with Flow and Linting
To run the tests:
```
npm run test
```sh
yarn run test
```

To continuously watch and run the unit-tests, execute the following:
```
npm run jest:watch
```sh
yarn run jest:watch
```

To perform linting with `eslint`, run the following:
```
npm run lint
```sh
yarn run lint
```

To perform a single check of the types with `flow`, run the following:
```sh
yarn run flow
```
npm run flow

### Development in the scaffold
In case you would like to contribute to the scaffold, we recommend you to change into `packages/create-react-microservice-scaffold/src` and run the following commands to bootstrap it.

```sh
yarn install
yarn run bootstrap
```

### New Features
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Creating scalable, universal and well tested JavaScript application for enterpri

**What about Next.js?**

This scaffold is not aimed at "competing" against Next.js, quite the contrary we see Next.js as a valid addition to the scaffold! We even provide you with a guide on how to integrate Next.js into our scaffold structure within minutes! :-)
This scaffold is not aimed at "competing" against Next.js, quite the contrary we see Next.js as a valid addition to the scaffold! We even provide you with a guide on [how to integrate Next.js into the scaffold structure]((/packages/create-react-microservice-scaffold/src/docs/recipes/IntegratingNextJs.md)) within minutes! :-)

**Why is this scaffold called `create-react-microservice` / What is a frontend-microservice?**

Expand Down

0 comments on commit f620fcf

Please sign in to comment.