IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
Marcus Efraimsson 2018-08-14 12:40:07 +02:00
parent 86a2789541
commit de25a4fe4e
No known key found for this signature in database
GPG Key ID: EBFE0FB04612DD4A
3 changed files with 13 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/CONTRIBUTING.md vendored
View File

@ -2,15 +2,11 @@ Follow the setup guide in README.md
### Rebuild frontend assets on source change ### Rebuild frontend assets on source change
``` ```
grunt && grunt watch yarn watch
``` ```
### Rerun tests on source change ### Rerun tests on source change
``` ```
npm run jest
```
or
```
yarn jest yarn jest
``` ```
@ -21,6 +17,6 @@ test -z "$(gofmt -s -l . | grep -v -E 'vendor/(github.com|golang.org|gopkg.in)'
### Run tests for frontend assets before commit ### Run tests for frontend assets before commit
``` ```
npm test yarn test
go test -v ./pkg/... go test -v ./pkg/...
``` ```

11
README.md
View File

@ -43,7 +43,7 @@ To build the assets, rebuild on file change, and serve them by Grafana's webserv
```bash ```bash
npm install -g yarn npm install -g yarn
yarn install --pure-lockfile yarn install --pure-lockfile
yarn run watch yarn watch
``` ```
Build the assets, rebuild on file change with Hot Module Replacement (HMR), and serve them by webpack-dev-server (http://localhost:3333): Build the assets, rebuild on file change with Hot Module Replacement (HMR), and serve them by webpack-dev-server (http://localhost:3333):
@ -56,7 +56,7 @@ Note: HMR for Angular is not supported. If you edit files in the Angular part of
Run tests Run tests
```bash ```bash
yarn run jest yarn jest
``` ```
### Recompile backend on source change ### Recompile backend on source change
@ -93,14 +93,13 @@ In your custom.ini uncomment (remove the leading `;`) sign. And set `app_mode =
#### Frontend #### Frontend
Execute all frontend tests Execute all frontend tests
```bash ```bash
yarn run test yarn test
``` ```
Writing & watching frontend tests Writing & watching frontend tests
- jest for all new tests that do not require browser context (React+more) - Start watcher: `yarn jest`
- Start watcher: `yarn run jest` - Jest will run all test files that end with the name ".test.ts"
- Jest will run all test files that end with the name ".test.ts"
#### Backend #### Backend
```bash ```bash

13
docs/sources/project/building_from_source.md
View File

@ -57,7 +57,7 @@ For this you need nodejs (v.6+).
```bash ```bash
npm install -g yarn npm install -g yarn
yarn install --pure-lockfile yarn install --pure-lockfile
npm run watch yarn watch
``` ```
## Running Grafana Locally ## Running Grafana Locally
@ -83,18 +83,17 @@ go get github.com/Unknwon/bra
bra run bra run
``` ```
You'll also need to run `npm run watch` to watch for changes to the front-end (typescript, html, sass) You'll also need to run `yarn watch` to watch for changes to the front-end (typescript, html, sass)
### Running tests ### Running tests
- You can run backend Golang tests using "go test ./pkg/...". - You can run backend Golang tests using `go test ./pkg/...`.
- Execute all frontend tests with "npm run test" - Execute all frontend tests with `yarn test`
Writing & watching frontend tests Writing & watching frontend tests
- jest for all new tests that do not require browser context (React+more) - Start watcher: `yarn jest`
- Start watcher: `npm run jest` - Jest will run all test files that end with the name ".test.ts"
- Jest will run all test files that end with the name ".test.ts"
## Creating optimized release packages ## Creating optimized release packages