To setup development environment...

1. Clone the project: git clone https://github.com/GalvinGao/penguin-stats-frontend.git

2. Install yarnpkg :

3. Install project dependencies:yarn

4. Fire up the development server: yarn serve

5. Get your favorite IDE and start developing!

Submit your changes

This project uses commitizen to organize commit messages. In order to utilize such tool, please:

1. Install commitizen: yarn global add commitizen

2. To start working on a feature/issue, use git checkout -b {branchName} to create a branch and switch to such branch; also, the {branchName} should in the following format:

First of all, thanks for your interest in contributing Penguin Statistics!

Please notice that the v4 Frontend is now in maintenance mode and a new version frontend is being planned and bootstrapped with React. New feature implementation is currently paused on the current v3 frontend.

Summary

• MVVC Framework: ; project created using vue-cli@3.

• UI Framework: , a framework that implements .

• CI: , GitHub Actions & Kubernetes.io

• CD: Kubernetes.io in progress

• Project Repo:

Contributing

You can contribute to the frontend of the website in many ways:

Penguin Delivery is an international organization which needs localization in order to fit every visitor ;). Penguin Delivery currently needs support from the localizers of the following languages:

The localization support will be divided into two priority categories: Primary and Secondary.

Primary Support

The languages in this group should always have full and high-quality localizations in order to provide model for other localizations.

• zh-cn: Chinese Simplified

• zh-tw: Chinese Traditional

• en-us

Secondary Support

This group don't have any strict requirements, but localizations are welcome.

• en-uk: English (United Kingdom)

• ko-kr: Korean (Korea)