Skip to content

Commit 018e90d

Browse files
committed
docs: add contribuiton.md into the project
1 parent 65dfd45 commit 018e90d

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUITION.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Contribuition
2+
3+
## Running project locally
4+
5+
### ReactTooltip (root)
6+
7+
1. Run `npm install` || `yarn` to install dependencies
8+
2. You can test by: `yarn dev` to run dev mode, or you can run **docs** directly using root folder instead of NPM, for this, please check **docs section**.
9+
10+
### Docs
11+
12+
You still need step 1 from `ReactTooltip (root)` section.
13+
Docs are commited using npm packages, but with this steps, you can use local ReactTooltip package build.
14+
15+
1. In **docs** folder, run `npm install` || `yarn` to install dependencies
16+
2. In **root** folder (parent of docs folder), run `yarn build` to generate a production build (you can use `yarn build --watch` to always generate a new build when a file changes)
17+
3. Change `package.json`:
18+
19+
From this:
20+
```
21+
"react": "18.2.0",
22+
"react-dom": "18.2.0",
23+
"react-tooltip": "5.0.0"
24+
```
25+
26+
To this:
27+
```
28+
"react": "link:../node_modules/react",
29+
"react-dom": "link:../node_modules/react-dom",
30+
"react-tooltip": "link:.."
31+
32+
```
33+
34+
4. Run `yarn start` and open `localhost:3000` to see docs running locally.
35+
36+
OBS: do not commit this change or the docs will broken the deployment and will not be updated.
37+
38+

0 commit comments

Comments
 (0)