Skip to content

Planimation FrontendLink

Latest Development Build Status

Build Status

Local DevLink

  • Required Node 18+

  • Open to package.json

    • For Window system, change the scripts content of package.json

      "scripts": { "start": "set NODE_OPTIONS=--openssl-legacy-provider&& node scripts/start.js", "build": "set NODE_OPTIONS=--openssl-legacy-provider&& node scripts/build.js", "test": "jest" }

    • For Linux/ubuntu system, change the scripts content of package.json

      "scripts": { "start": "NODE_OPTIONS=--openssl-legacy-provider node scripts/start.js ", "build": "NODE_OPTIONS=--openssl-legacy-provider node scripts/build.js", "test": "jest" }

Docker BuildLink

  • Install Docker
  • Make sure the scripts in package.json are correct with different system(See Local Dev Item 2).

  • Go to the frontend folder

    docker build -t planimation-frontend:latest -f ./Dockerfile ./ docker run -d -p 8080:8080 planimation-frontend:latest

  • Test the web server is running by visiting localhost:8080 in the browser.

ContributionLink

When contributing to this repository, please adhere to the below guidelines.

Create an issueLink

  • Before pushing code to the repo, it is required to create an issue along with a brief description so that peer developers can review, provide suggestions and feedback.
  • Create a new issue to obtain ISSUE_NO.

Pre-push changesLink

Before pushing the code to repo please make sure to:

  1. Update the README.md with details of changes to the interface, this includes the new environment variables, exposed ports, useful file locations and container parameters, if any.
  2. Increase the version numbers in any examples files and the README.md to the new version if any.
  3. The version number scheme, we follow SemVer.

Commit message formatLink

  • Set the commit template as follows: git config user.name "Your Full Name" git config user.name "Your GitHut email" git config commit.template .gitmessage

  • Commit message should be of the following format [ISSUE_NO] COMMIT_MESSAGE. Refer .gitmessage. Example: ``` [10] Fix security issue related with form

    • Updated lib dependency version
    • Fixed something
    • Fixed other thing

    Resolves #10 ```

Pull Request and peer code review processLink

Please note that you cannot push directly to develop nor master branches.

  • Create a new branch and push the changes to this branch.
  • Create a PR and add at least one peer reviewer.
  • You may merge your branch to develop once your PR is approved by your peer reviewer.
  • If you do not have permission to merge the PR, please contact the reviewer to merge it for you.