|
1 | | -# Setting up |
| 1 | +# AlphaNUS |
2 | 2 |
|
3 | | -**Prerequisites** |
| 3 | + |
4 | 4 |
|
5 | | -* JDK 11 |
6 | | -* Recommended: IntelliJ IDE |
7 | | -* Fork this repo to your GitHub account and clone the fork to your computer |
| 5 | +* AlphaNUS is an app intended for the treasurers of NUS clubs. The user interactions will occur using the CLI. |
| 6 | +* The purpose of the app is to categorize the deadline of the payment forms, expenses of events and history of tasks completed. This allows the treasurer to be organized and efficiently keep track of their tasks. |
| 7 | +* AlphaNUS is written in OOP fashion. |
| 8 | +* [User Guide](https://github.com/AY1920S1-CS2113T-F10-3/main/blob/master/docs/UserGuide.adoc) |
| 9 | +* [Developer Guide](https://github.com/AY1920S1-CS2113T-F10-3/main/blob/master/docs/DeveloperGuide.adoc) |
| 10 | +* [AboutUs](https://github.com/AY1920S1-CS2113T-F10-3/main/blob/master/docs/AboutUs.adoc) |
8 | 11 |
|
9 | | -**Importing the project into IntelliJ** |
10 | | - |
11 | | -1. Open IntelliJ (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project dialog first). |
12 | | -1. Set up the correct JDK version. |
13 | | - * Click `Configure` > `Structure for new Projects` (in older versions of Intellij:`Configure` > `Project Defaults` > `Project Structure`). |
14 | | - * If JDK 11 is listed in the drop down, select it. If it is not, click `New...` and select the directory where you installed JDK 11. |
15 | | - * Click `OK`. |
16 | | -1. Click `Import Project`. |
17 | | -1. Locate the project directory and click `OK`. |
18 | | -1. Select `Create project from existing sources` and click `Next`. |
19 | | -1. Rename the project if you want. Click `Next`. |
20 | | -1. Ensure that your src folder is checked. Keep clicking `Next`. |
21 | | -1. Click `Finish`. |
22 | | - |
23 | | -# Tutorials |
24 | | - |
25 | | -Duke Increment | Tutorial |
26 | | ----------------|--------------- |
27 | | -`A-Gradle` | [Gradle Tutorial](tutorials/gradleTutorial.md) |
28 | | -`A-TextUiTesting` | [Text UI Testing Tutorial](tutorials/textUiTestingTutorial.md) |
29 | | -`Level-10` | JavaFX tutorials:<br>→ [Part 1: Introduction to JavaFX][fx1]<br>→ [Part 2: Creating a GUI for Duke][fx2]<br>→ [Part 3: Interacting with the user][fx3]<br>→ [Part 4: Introduction to FXML][fx4] |
30 | | - |
31 | | -[fx1]: <tutorials/javaFxTutorialPart1.md> |
32 | | -[fx2]: <tutorials/javaFxTutorialPart2.md> |
33 | | -[fx3]: <tutorials/javaFxTutorialPart3.md> |
34 | | -[fx4]: <tutorials/javaFxTutorialPart4.md> |
35 | | - |
36 | | -# Feedback, Bug Reports |
37 | | - |
38 | | -* If you have feedback or bug reports, please post in [se-edu/duke issue tracker](https://github.com/se-edu/duke/issues). |
39 | | -* We welcome pull requests too. |
0 commit comments