Setting up and getting started
(Contributed by Yu Ming)
1. Prerequisites
- JDK 11 or above
- IntelliJ IDE (Highly recommended)
IntelliJ by default has Gradle and JavaFx plugins installed. Do not disable them. If you have disabled them, go to
File
>Settings
>Plugins
to re-enable them.
2. Setting up the project in your computer
Follow the steps in the following guide precisely. Things will not work out if you deviate in some steps.
- First, fork this repo, and clone the fork into your computer.
- Configure the JDK: Follow the guide [se-edu/guides] IDEA: Configuring the JDK to to ensure Intellij is configured to use JDK 11.
- Import the project as a Gradle project: Follow the guide [se-edu/guides] IDEA: Importing a Gradle project to import the project into IDEA.
Note: Importing a Gradle project is slightly different from importing a normal Java project.
3. Verify the setup
- Run the
seedu.address.Main
and try a few commands. - Run the tests to ensure they all pass.
4. Before writing code
-
Configure the coding style
If using IDEA, follow the guide [se-edu/guides] IDEA: Configuring the code style to set up IDEA’s coding style to match ours.
Optionally, you can follow the guide [se-edu/guides] Using Checkstyle to find how to use the CheckStyle within IDEA e.g., to report problems as you write code.
-
Set up CI
This project comes with a GitHub Actions config files (in
.github/workflows
folder). When GitHub detects those files, it will run the CI for your project automatically at each push to themaster
branch or to any PR. No set up required. -
Learn the design
When you are ready to start coding, we recommend that you get some sense of the overall design by reading about NUSave’s architecture.
-
Do the tutorials These tutorials will help you get acquainted with the codebase.