Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
N
nexpie-grafana-theme
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Registry
Registry
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kornkitt Poolsup
nexpie-grafana-theme
Commits
de25a4fe
Unverified
Commit
de25a4fe
authored
Aug 14, 2018
by
Marcus Efraimsson
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: update
parent
86a27895
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
13 additions
and
19 deletions
+13
-19
.github/CONTRIBUTING.md
+2
-6
README.md
+5
-6
docs/sources/project/building_from_source.md
+6
-7
No files found.
.github/CONTRIBUTING.md
View file @
de25a4fe
...
@@ -2,15 +2,11 @@ Follow the setup guide in README.md
...
@@ -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)'
...
@@ -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/...
```
```
README.md
View file @
de25a4fe
...
@@ -43,7 +43,7 @@ To build the assets, rebuild on file change, and serve them by Grafana's webserv
...
@@ -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
...
@@ -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 =
...
@@ -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
...
...
docs/sources/project/building_from_source.md
View file @
de25a4fe
...
@@ -57,7 +57,7 @@ For this you need nodejs (v.6+).
...
@@ -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 ru
n watch
yar
n watch
```
```
## Running Grafana Locally
## Running Grafana Locally
...
@@ -83,18 +83,17 @@ go get github.com/Unknwon/bra
...
@@ -83,18 +83,17 @@ go get github.com/Unknwon/bra
bra run
bra run
```
```
You'll also need to run
`
npm ru
n watch`
to watch for changes to the front-end (typescript, html, sass)
You'll also need to run
`
yar
n 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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment