-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
9 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 |
---|---|---|
@@ -1,39 +1,43 @@ | ||
# Moira Web 2.0 [![Build Status](https://travis-ci.org/moira-alert/web2.0.svg?branch=master)](https://travis-ci.org/moira-alert/web2.0) [![Dependency Status](https://david-dm.org/moira-alert/web2.0.svg)](https://david-dm.org/moira-alert/web2.0) | ||
|
||
After clone repo make sure you installed all dependencies by run `yarn install`. | ||
If you're new here, better check out our main [README](https://github.com/moira-alert/moira/blob/master/README.md). | ||
|
||
## Build | ||
## Development | ||
|
||
After cloning repo make sure you have installed all dependencies by running `yarn install`. | ||
|
||
### Building | ||
|
||
`yarn build` | ||
|
||
All files will prepared in **dist** folder. | ||
All files will be prepared in **dist** folder. | ||
|
||
## Developing | ||
|
||
`yarn start` | ||
|
||
Start dev server on port 9000. Need to run `yarn fakeapi` in parallel for data. Fake API server starts on port 9002. | ||
Starts dev server on port 9000. You'll have to run `yarn fakeapi` in separate terminal to provide mock API data. Mock API server starts on port 9002. | ||
|
||
`yarn start --env.API=local` | ||
|
||
Start dev server with proxy to your API service. Make sure you setup local Moira API service and add it URL to `webpack.config.js` in `devServer.proxy` block. | ||
Starts dev server with proxy to your API service. Make sure you setup local Moira API service and add it URL to `webpack.config.js` in `devServer.proxy` block. | ||
|
||
`yarn storybook` | ||
|
||
Start [Storybook](https://storybook.js.org) on port 9001. | ||
Starts [Storybook](https://storybook.js.org) on port 9001. | ||
|
||
`yarn lint` | ||
|
||
[ESLint](https://eslint.org) check. _Recommend run before commit_. | ||
[ESLint](https://eslint.org) check. _Recommended to run before commit_. | ||
|
||
`yarn flow` | ||
|
||
Start [Flow](https://flow.org) server for checking types. You can also run `yarn flow.status` for status, `yarn flow.check` for errors report, `yarn flow.coverage.html` for export report to html with cute UI. | ||
Starts [Flow](https://flow.org) server for checking types. You can also run `yarn flow.status` for status, `yarn flow.check` for errors report, `yarn flow.coverage.html` to export html report with cute UI. | ||
|
||
## Contributing | ||
|
||
Put issues [in main repo](https://github.com/moira-alert/moira/issues), please. Even if you think, that your issue only about web interface. In many cases that's no so. Thank you! | ||
|
||
--- | ||
|
||
[More about Moira](https://github.com/moira-alert/moira/blob/master/README.md) | ||
[More about Moira](https://github.com/moira-alert/moira/blob/master/README.md) |