Penguin Statistics!
This is the backend project repository for the Penguin Statistics website.
Technologies
Maintainers
This frontend project has mainly being maintained by the following contributors (in alphabetical order):
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
Deployment
Preparations
- Install Maven
- Install Lombok plugin for your IDE
- (Optional) Install MongoDB
- (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>
- Edit
src/main/resources/application.yml
,change the value ofusername
andpassword
inspring.data.mongodb.uri
according to your settings.
Run
- Execute
mvn spring-boot:run
in the root directory of this project. Or run the main method inPenguinStatisticsApplication
class. - If you see "PenguinStats is running" in the console, congrats!
Build
Execute mvn clean package
, then deploy target/PenguinStats.war
to the server.