TermiNUS

This is a project template for a greenfield Java project. It's named after the Java mascot Duke. Given below are instructions on how to use it.

Setting up

Prerequisite

Before setting up the project, please do ensure you have the following items installed.

• JDK 11
• IntelliJ IDEA

Java Development Kit ver 11 (JDK 11) is the environment / programming language in which TermiNUS is written with and IntelliJ IDEA will be the integrated development environment ( IDE) platform for us to write the programming codes on.

Go to link and retrieve the TermiNUS project file. You can do so by forking the project and cloning a copy into your computer.

To learn more about github fork-clone feature please follow the guide on link.

Setting up in Intellij

1. Open the application IntelliJ IDEA.

2. Inside IntelliJ IDEA navigate to open project button

   1. On the top left of the app, File→Open...

3. Locate and select the folder containing the files for Terminus that you have downloaded earlier on.

4. Change the Project SDK that IntelliJ IDEA will be using.

   1. On the top left of the app, File→Project Structure...
   2. Under Project SDK: section, find and select JDK version 11. Eg: Amazon Corretto version 11.0.12.
   3. Under Project language level:, select SDK default.

5. Verifying the setup

   1. After performing the steps above, locate the file src/main/java/terminus/Terminus.java, right-click and select Run 'Terminus.main()'.
   2. If everything is correctly set up, you should see the following terminal.

   Welcome to TermiNUS!
   
   Type any of the following to get started:
   > exit
   > help
   > note
   > schedule
   
   [] >>>
   
   

Build automation using Gradle

• This project uses Gradle for build automation and dependency management. It includes a basic build script as well (i.e. the build.gradle file).
• If you are new to Gradle, refer to the Gradle Tutorial at se-education.org/guides.

Testing

I/O redirection tests

• To run I/O redirection tests (aka Text UI tests), navigate to the text-ui-test and run the runtest(.bat/.sh) script.

JUnit tests

• We use JUnit testing for this project.
• If you are new to JUnit, refer to the JUnit Tutorial at se-education.org/guides.

Checkstyle

• A CheckStyle rule configuration is provided in this project.
• If you are new to Checkstyle, refer to the Checkstyle Tutorial at se-education.org/guides.

CI using GitHub Actions

The project uses GitHub actions for CI. When you push a commit to this repo or PR against it, GitHub actions will run automatically to build and verify the code as updated by the commit/PR.

Documentation

/docs folder contains a skeleton version of the project documentation.

Steps for publishing documentation to the public:

1. If you are using this project template for an individual project, go your fork on GitHub.
   If you are using this project template for a team project, go to the team fork on GitHub.
2. Click on the settings tab.
3. Scroll down to the GitHub Pages section.
4. Set the source as master branch /docs folder.
5. Optionally, use the choose a theme button to choose a theme for your documentation.