Skip to content

Commit

Permalink
Merge pull request #336 from keep-network/add-development-docs
Browse files Browse the repository at this point in the history
Add dev docs

Add Development and Deployment sections to the README.
  • Loading branch information
Shadowfiend authored Mar 18, 2021
2 parents 40d8766 + 970b579 commit 069dd83
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
# keep.network
# keep.network website

The Keep network website - [keep.network](https://keep.network)

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

Want to contribute? Check out our [guidelines](CONTRIBUTING.md).

## Development
### Setup
Install dependencies:

```sh
npm install
```

### Run
To run the app in the development mode:
```sh
npm run develop
```

Open http://localhost:8000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

## Deployment
Currently the site is auto-deployed on master merge to Google Cloud Storage and fronted by Cloudflare at [keep.network](https://keep.network/). Pull requests (including those created by the CMS) are auto-deployed to subdirectories at [preview.keep.network](https://preview.keep.network) by branch name.

0 comments on commit 069dd83

Please sign in to comment.