-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #336 from keep-network/add-development-docs
Add dev docs Add Development and Deployment sections to the README.
- Loading branch information
Showing
1 changed file
with
22 additions
and
1 deletion.
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 |
---|---|---|
@@ -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. |