Planimation Frontend

Demo

https://planimation.planning.domains/

Docker Build

• Under the root folder

docker build -t planimation_js .
docker run --name planimation_js_frontend -dp 8080:8080 planimation_js

Please make sure the docker port is same as the port number in nginx.conf.

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

Test your code:

yarn test  //or “npm test” or testing in Jest
./node_modules/.bin/cypress open // for testing in Cypress

Contribution

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

Create an issue

• 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 changes

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 format

• 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 process

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.