-
Notifications
You must be signed in to change notification settings - Fork 1
Local Installation Guide
To be able to develop this, you will have to clone the project and install the dependencies. This will show a quick way of how to get yourself up and running with this project.
Cloning is relatively simple. All you have to do is choose the right setup. If you have your SSH keys setup with github then clone via SSH.
If you have setup your keys with git, use the following to clone the project.
git clone git@github.com:javaplebes/TextAdventure.git
If you do not have your SSH keys setup, you can clone the repository via HTTPS.
git clone https://github.com/javaplebes/TextAdventure.git
A dependency is something that a project depends on to be there for it to run, be it a library or an API or another project. When you first clone the repository, you will not have any dependencies as this is very wasteful of bandwidth and with large projects cloning stuff will take forever. This also ensures that the latest dependencies are used.
To download the dependencies you can use maven.
mvn install
As with all other projects, testing is an important part of software lifecycle. It allows to catch bugs early on and ensures a smooth development experience.
This project currently uses JUnit for unit tests.
You can run the tests via maven.
mvn test