Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Shift the development-related stuff out of README and into CONTRIBUTING
- Loading branch information
Showing
2 changed files
with
62 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing | ||
|
||
## Development | ||
|
||
### Install | ||
|
||
> Clone the project on your computer, and install [Node](https://nodejs.org). This project also uses [nvm](https://github.com/springload/frontend-starter-kit/blob/master/docs/useful-tooling.md#nvm). | ||
```sh | ||
nvm install | ||
# Then, install all project dependencies. | ||
npm install | ||
# Install the git hooks. | ||
./.githooks/deploy | ||
# Set up a `.env` file with the appropriate secrets. | ||
touch .env | ||
``` | ||
|
||
### Working on the project | ||
|
||
> Everything mentioned in the installation process should already be done. | ||
```sh | ||
# Make sure you use the right node version. | ||
nvm use | ||
# Start the the development tools in watch mode. | ||
npm run start | ||
# Runs linting. | ||
npm run lint | ||
# Runs tests. | ||
npm run test | ||
# View other available commands with: | ||
npm run | ||
``` | ||
|
||
### Run the demo | ||
|
||
> Everything mentioned in the installation process should already be done. | ||
```sh | ||
# Make sure you use the right node version. | ||
nvm use | ||
# Start the server and the development tools. | ||
npm run start-demo | ||
``` | ||
|
||
### Publish | ||
|
||
```sh | ||
npm version [TYPE] | ||
git push origin master --tags | ||
npm publish | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters