MikeyZat / wild-world-simulator

Java application simulating simplified world of animals and their evolution.

Welcome to Wild World Simulator

This project was made for Objected Programming classes. You can find its full description there.

This project is owned and managed by:

- Mikołaj Zatorski

🏃 How to run:

Requirements:

• Java jdk (Simulator)
• Node.js (Visualisation)
• Npm (Visualisation) // you get it with Node

Running steps:

• in the console type:
  • git clone https://github.com/MikeyZat/wild-world-simulator.git
  • cd wild-world-simulator
  • npm install
  • npm run visualisation-install (it might take 1-3 minutes)
  • npm run visualisation
• If everything went smooth you should be able to see landing page after entering http://localhost:3000/ in your browser
• Follow directions shown in the browser and enjoy your simulation 😎

📚 Documentation

- Simulator Java service docs

- Visualisation React.js service docs

🙌 Contributing

If you have some improvements or bug fixes feel free to commit using these steps:

• fork the repository
• create your branch following name conventions (feat/some-feature or bug/some-bug)
• apply your changes
• TEST your changes (not only in positive scenarios)
• commit your changes and add DESCRIPTIVE commit message ("fix some bugs" is not a good description)
• push your changes and made a PR with exact description WHAT you did, HOW you did and WHY
• assign me for a review