Merge from lidangzzz/dev: release 0.7.0

Merge 'dev' into 'master'

.github/workflows/nodejs.yml

@@ -5,27 +5,31 @@ on: [push, pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
-    env:
-      working-directory: ./hedgehog-lab
     steps:
       - uses: actions/checkout@v1
+
       - name: Use Node.js 12.x
         uses: actions/setup-node@v1
         with:
           node-version: '12.x'
-      - name: Cache NPM dependencies
-        uses: actions/cache@v1
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
-          path: ~/.npm
-          key: ${{ runner.OS }}-npm-cache
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            ${{ runner.OS }}-npm-cache
+            ${{ runner.os }}-yarn-
+
       - name: Install Dependencies
         run: |
-          npm i
-        working-directory: ${{ env.working-directory }}
+          yarn --frozen-lockfile --non-interactive
+
       - name: Build
-        run: npm run build
+        run: yarn build
         env:
           CI: true
-        working-directory: ${{ env.working-directory }}

.gitignore

@@ -1,3 +1,28 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/yarn
+# Edit at https://www.toptal.com/developers/gitignore?templates=yarn
+
+### yarn ###
+# https://yarnpkg.com/advanced/qa#which-files-should-be-gitignored
+
+# .yarn/unplugged and .yarn/build-state.yml should likely always be ignored since
+# they typically hold machine-specific build artifacts. Ignoring them might however
+# prevent Zero-Installs from working (to prevent this, set enableScripts to false).
+.yarn/unplugged
+.yarn/build-state.yml
+
+# .yarn/cache and .pnp.* may be safely ignored, but you'll need to run yarn install
+# to regenerate them between each branch switch.
+# Uncomment the following lines if you're not using Zero-Installs:
+# .yarn/cache
+# .pnp.*
+
+# End of https://www.toptal.com/developers/gitignore/api/yarn
+
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
 # Logs
 logs
 *.log
@@ -84,7 +109,7 @@ dist
 
 # Gatsby files
 .cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# Comment in the public line in if your project uses Gatsby and not Next.js
 # https://nextjs.org/blog/next-9-1#public-directory-support
 # public
 
@@ -104,4 +129,12 @@ dist
 .tern-port
 
 # Vscode setting file
-.vscode
+.vscode
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# End of https://www.toptal.com/developers/gitignore/api/node
+
+
+.DS_Store

hedgehog-lab/README.md → CONTRIBUTING.md

@@ -1,13 +1,10 @@
-> For historical reasons, we have temporarily switched the package manager to NPM
-
----
 # Contributing Guide
 
 ## Setting up your environment
 
 If you are making a Pull Request, please fork the hedgehog-lab repository before continuing.
 
-More information on forking or GitHub usage please navigate: https://docs.github.com/en/github/getting-started-with-github
+More information on forking or GitHub usage please navigate: [https://docs.github.com/en/github/getting-started-with-github](https://docs.github.com/en/github/getting-started-with-github)
 
 ```bash
 # Example of cloning the hedgehog-lab repository (forked)
@@ -22,41 +19,38 @@ git clone [email protected]:<your_username>/hedgehog-lab.git
 Once cloned, navigate to the folder by typing cd `hedgehog-lab` and then running the following commands:
 
 ```bash
-# Navigate to the hedgehog-lab folder
-cd hedgehog-lab/hedgehog-lab
-
 # Install all project dependencies
-npm i
+yarn install
 
 # Start the project
-npm run start
+yarn watch
 ```
 
-Start your local development server(may take awhile) by running `npm run start` in the terminal.
+Start your local development server(may take a while) by running `yarn watch` in the terminal.
 
 ## Recommended packages(draft)
 
 > About this section, The core team is under discussion, So you may not follow these Settings for the time being.
 
 ### Commitizen(draft)
 
-The [Commitizen](https://github.com/commitizen/cz-cli) allows for easy to read and organized commits with minimal change to normal commit functions. To get started, Please navigate: https://github.com/commitizen/cz-cli
+The [Commitizen](https://github.com/commitizen/cz-cli) allows for easy to read and organized commits with minimal change to normal commit functions. To get started, Please navigate: [https://github.com/commitizen/cz-cli](https://github.com/commitizen/cz-cli)
 
 ### Commit Guidelines w/Commitizen(draft)
 
 All commits will be auto-formatted by commitizen following a fluid interface
 
 ### Commit types(draft)
 
-* **feat**: Commits that result in new features. Backward compatible features will release with the next MINOR whereas breaking changes will be in the next MAJOR. The body of a commit with breaking changes must begin with BREAKING CHANGE, followed by a description of how the API has changed.
-* **fix**: Commits that provide fixes for bugs within hedgehog-lab's codebase.
-* **docs**: Commits that provide updates to the docs.
-* **style**: Commits that do not affect how the code runs, these are simply changes to formatting.
-* **refactor**: Commits that neither fixes a bug nor adds a feature.
-* **perf**: Commits that improve performance.
-* **test**: Commits that add missing or correct existing tests.
-* **chore**: Other commits that don't modify core or test files.
-* **revert**: Commits that revert previous commits.
+- **feat**: Commits that result in new features. Backward compatible features will release with the next MINOR whereas breaking changes will be in the next MAJOR. The body of a commit with breaking changes must begin with BREAKING CHANGE, followed by a description of how the API has changed.
+- **fix**: Commits that provide fixes for bugs within hedgehog-lab's codebase.
+- **docs**: Commits that provide updates to the docs.
+- **style**: Commits that do not affect how the code runs, these are simply changes to formatting.
+- **refactor**: Commits that neither fixes a bug nor adds a feature.
+- **perf**: Commits that improve performance.
+- **test**: Commits that add missing or correct existing tests.
+- **chore**: Other commits that don't modify core or test files.
+- **revert**: Commits that revert previous commits.
 
 ## Submitting Changes / Pull Requests(draft)
 
@@ -66,10 +60,11 @@ Before doing any commits, you will want to pull down the latest and greatest fro
 
 ### Pull Requests For hedgehog-lab(draft)
 
-> Pull requests related to the hedgehog-lab core:  
-* For bug fixes and documentation updates submit pull requests to master.  
-* For new features and enhancements submit pull requests to dev
+> Pull requests related to the hedgehog-lab core:
+
+- For bug fixes and documentation updates submit pull requests to master.
+- For new features and enhancements submit pull requests to dev
 
 ### Pull Requests For Docs
 
-For any pull requests related to hedgehog-lab docs, submit your pull request to the master branch.
+For any pull requests related to hedgehog-lab docs, submit your pull request to the master branch.

README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Hedgehog Lab</h1>
 
-[Hedgehog Lab](https://hedgehog-lab.github.io/) Hedgehog Lab is an open source scientific computation tool in the browser.
+[Hedgehog Lab](https://hedgehog-lab.github.io/) is an open source scientific computation tool in the browser.
 
 Try it at [https://hedgehog-lab.github.io/](https://hedgehog-lab.github.io/)
 
@@ -18,26 +18,23 @@ git clone https://github.com/lidangzzz/hedgehog-lab.git
 git clone [email protected]:lidangzzz/hedgehog-lab.git
 ```
 
-Once cloned, switch to the master branch and navigate to the folder by typing cd `hedgehog-lab/hedgehog-lab` and then running the following commands:
+Once cloned, switch to the master branch and navigate to the folder by typing `cd hedgehog-lab` and then running the following commands:
 
 ```bash
 # Switch to the master branch
 git checkout master
 
-# Navigate to the hedgehog-lab folder
-cd hedgehog-lab/hedgehog-lab
-
 # Install all project dependencies
-npm i
+yarn install
 
 # Start the project
-npm run start
+yarn watch
 ```
 
 ## Contributing
 
-Read our [contributing guide](/hedgehog-lab/README.md) to learn how to develop the project.
+Read our [contributing guide](CONTRIBUTING.md) to learn how to develop the project.
 
 ## License
 
-This project is licensed under the terms of the [Apache-2.0 License](LICENSE).
+This project is licensed under the terms of the [Apache-2.0 License](LICENSE).