forked from LiveDuo/destack
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,21 @@ | ||
# Contributing to the project | ||
|
||
- ## Instructions for development | ||
### Instructions for development | ||
|
||
1. `git clone https://github.com/LiveDuo/destack` and cd in there | ||
1. Fork this repository and clone the forked repository with `git clone` | ||
|
||
2. `npm i` | ||
2. `cd` in the project folder and run `npm i` | ||
|
||
3. `npm run dev` and head to `localhost:3000` | ||
3. `npm run dev` and head to `localhost:3000` (for React.js use `npm run dev:react`) | ||
|
||
4. Make changes in lib/destack and create a PR 🚀 | ||
|
||
Note: Requires NPM version 7 or later (which supports NPM workspaces). To update NPM to the latest version run the following, `sudo npm install -g npm`. | ||
|
||
### Instructions for deploying | ||
|
||
- Alpha: `npm run publish:alpha` | ||
|
||
- Beta: `npm run publish:beta` | ||
|
||
- Stable: `npm publish` |