Penguin Statistics!

This is the backend project repository for the Penguin Statistics website.

Technologies

• Maven
• Spring Boot 2.1.6
• MongoDB

Maintainers

This frontend project has mainly being maintained by the following contributors (in alphabetical order):

• AlvISsReimu
• ChaosNiku
• YukiC

The full list of active contributors of the Penguin Statistics project can be found at the Team Members page of the website.

How to contribute?

Our contribute guideline can be found at Penguin Developers. PRs are always more than welcome!

API docs

• Introductions to API v2
• Swagger API docs

Deployment

Preparations

1. Install Maven
2. Install Lombok plugin for your IDE
3. (Optional) Install MongoDB
4. (Optional) If you choose to run MongoDB locally, feel free to contact our team for the dumped testing file, execute the following command to import them:

mongorestore -h localhost:<your mongodb port> -d penguin_stats <path of penguin_stats directory>

5. Edit src/main/resources/application.yml，change the value of username and password in spring.data.mongodb.uri according to your settings.

Run

1. Execute mvn spring-boot:run in the root directory of this project. Or run the main method in PenguinStatisticsApplication class.
2. If you see "PenguinStats is running" in the console, congrats!

Build

Execute mvn clean package, then deploy target/PenguinStats.war to the server.