Skip to content

Commit 75a8459

Browse files
committed
avoid duplication
1 parent c65d9e0 commit 75a8459

File tree

2 files changed

+7
-91
lines changed

2 files changed

+7
-91
lines changed

chartlets.js/README.md

Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,14 @@
11
# Chartlets
22

3-
[![Frontend CI workflow](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml)
4-
[![NPM Version](https://badge.fury.io/js/chartlets.svg)](https://npmjs.org/package/chartlets)
3+
[![CI](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/frontend-ci.yml)
4+
[![npm](https://badge.fury.io/js/chartlets.svg)](https://npmjs.org/package/chartlets)
55
![](https://img.shields.io/badge/Linting-TypeScript%20%26%20Prettier-blue?logo=typescript&logoColor=white)
66

7-
8-
[![NPM Download Stats](https://nodei.co/npm/chartlets.png?downloads=true)](https://www.npmjs.com/package/chartlets)
9-
107
Chartlets is a software framework that allows websites developed with
118
React to be extended by server-side widgets programmed in Python or other
129
programming languages.
1310

14-
This is the JavaScript/React library of the framework.
11+
This is the **JavaScript/React library** of the framework.
1512

1613
For details refer to the [documentation](https://bcdev.github.io/chartlets/).
1714

18-
## Run demo server
19-
20-
Create environment and install library
21-
22-
``` bash
23-
cd ${project}/chartlets.py
24-
mamba env create
25-
conda activate chartlets
26-
pip install -ve .
27-
```
28-
29-
Run demo server
30-
31-
``` bash
32-
cd ${project}/chartlets.py/demo
33-
python -m server.main
34-
```
35-
36-
## Run demo UI
37-
38-
Install common dependencies
39-
40-
``` bash
41-
cd ${project}/chartlets.js
42-
npm install
43-
```
44-
45-
Build the library
46-
47-
``` bash
48-
cd ${project}/chartlets.js/packages/lib
49-
npm run build
50-
```
51-
52-
Run the demo UI
53-
54-
``` bash
55-
cd ${project}/chartlets.js/packages/demo
56-
npm run dev
57-
```

chartlets.py/README.md

Lines changed: 4 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,13 @@
11
# Chartlets
22

3-
[![Backend CI workflow](https://github.com/bcdev/chartlets/actions/workflows/backend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/backend-ci.yml)
4-
[![PyPI Version](https://img.shields.io/pypi/v/chartlets)](https://pypi.org/project/chartlets/)
5-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
3+
[![CI](https://github.com/bcdev/chartlets/actions/workflows/backend-ci.yml/badge.svg)](https://github.com/bcdev/chartlets/actions/workflows/backend-ci.yml)
4+
[![PyPI](https://img.shields.io/pypi/v/chartlets)](https://pypi.org/project/chartlets/)
5+
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
66

77
Chartlets is a software framework that allows websites developed with
88
React to be extended by server-side widgets programmed in Python or other
99
programming languages.
1010

11-
This is the Python backend library of the framework.
11+
This is the **Python backend library** of the framework.
1212

1313
For details refer to the [documentation](https://bcdev.github.io/chartlets/).
14-
15-
## Run demo server
16-
17-
Create environment and install library
18-
19-
``` bash
20-
cd ${project}/chartlets.py
21-
mamba env create
22-
conda activate chartlets
23-
pip install -ve .
24-
```
25-
26-
Run demo server
27-
28-
``` bash
29-
cd ${project}/chartlets.py/demo
30-
python -m server.main
31-
```
32-
33-
## Run demo UI
34-
35-
Install common dependencies
36-
37-
``` bash
38-
cd ${project}/chartlets.js
39-
npm install
40-
```
41-
42-
Build the library
43-
44-
``` bash
45-
cd ${project}/chartlets.js/packages/lib
46-
npm run build
47-
```
48-
49-
Run the demo UI
50-
51-
``` bash
52-
cd ${project}/chartlets.js/packages/demo
53-
npm run dev
54-
```

0 commit comments

Comments
 (0)