Skip to content

Commit 8f92426

Browse files
Readme (#200)
1 parent 8d8baa8 commit 8f92426

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Labs
2+
3+
Labs is the monorepo codebase for Leaning Technologies developer sites. It contains technical writing (documentation and blog posts) for Cheerp, CheerpJ, CheerpX and other projects.
4+
5+
Visit our sites:
6+
7+
- [Labs](https://labs.leaningtech.com/)
8+
- [Cheerp.io](https://cheerp.io/)
9+
- [CheerpX.io](https://cheerpx.io/)
10+
- [CheerpJ.com](https://cheerpj.com/)
11+
12+
# Running locally
13+
14+
## Setup
15+
16+
Make sure you have [Node.js](https://nodejs.org/en/download/package-manager) and [pnpm](https://pnpm.io/installation) installed.
17+
18+
## Clone this repository
19+
20+
```shell
21+
git clone https://github.com/leaningtech/labs.git
22+
```
23+
24+
## Install dependencies
25+
26+
```shell
27+
cd labs
28+
pnpm install
29+
```
30+
31+
## Run a site
32+
33+
The sites under this repository must be run individually. Pick a site you want to run, for example [Cheerp.io](https://cheerp.io/):
34+
35+
```shell
36+
cd /sites/cheerp
37+
pnpm start
38+
```
39+
40+
# Contributing
41+
42+
For more information about contributing, please [visit this page](https://labs.leaningtech.com/docs/contributing)

0 commit comments

Comments
 (0)