diff --git a/README.md b/README.md index b306e72..5817e53 100644 --- a/README.md +++ b/README.md @@ -1 +1,87 @@ -# SC2002 CAMs Project +# Camp Application and Management System (CAMs) + + +Camp Application and Management System (CAMs) is an application for staff and students to manage, view and register for camps within NTU. The application will act as a centralized hub for all staff and students. + + +# Setup Instructions + +1. Open your terminal + +2. Clone the repository: + + ```bash + git clone https://github.com/jhmarkkk/SC2002_CAMs.git + ``` + +3. Navigate repository: + + ```bash + cd SC2002_CAMs + ``` + +4. Compile the project: + + ```bash + javac -cp src -d bin src/main/CAMs.java + ``` + +5. Run the project: + + ```bash + java -cp bin main.CAMs + ``` + + +## Login Credentials + +This section contains some login credentials for users with different roles. The full list is available in the CSV files in data folder. + +**Students:** + +```bash +# Student 1 +USERID: YCHERN +PASSWORD: P@$$w0rd + +# Student 2 +USERID: BR015 +PASSWORD: P@$$w0rd + +# Student 3 +USERID: KOH1 +PASSWORD: P@$$w0rd + +# Student 4 +USERID: DL007 +PASSWORD: P@$$w0rd + +# Student 5 +USERID: CT113 +PASSWORD: password +``` + +**Committee Members:** + +```bash +# Committee Member 1 +USERID: LE51 +PASSWORD: P@$$w0rd + +# Committee Member 2 +USERID: ELI34 +PASSWORD: P@$$w0rd +``` + +**Staffs:** + +```bash +# Staff 1 +USERID: OURIN +PASSWORD: P@$$w0rd + +# Staff 2 +USERID: ANWIT +PASSWORD: P@$$w0rd +``` +