ay2324s1-course-assessment-g47

ay2324s1-course-assessment-g47 created by GitHub Classroom

Table of Contents

1. Assignment 1
2. Assignment 2
3. Assignment 3
4. Assignment 4
5. Assignment 5 and Project
6. Setting up PostgreSQL Permissions

Assignment instructions

Assignment 1:

Setup: Run start index.html in IDE terminal
_{Note: Since the question data is stored using local storage, no questions will be shown on initial start up, you will need to add some questions manually first.}

Assignment 2:

Follow these steps to run the project:

1. Ensure you have a .env file in the backend folder.

   Sample .env file content in the backend folder:

   DB_USER=postgres
   DB_HOST=localhost
   DB_PASSWORD=YOUR_POSTGRES_PASSWORD
   DB_PORT=YOUR_POSTGRES_PORT->5432
   DB_DATABASE=cs3219_g47
   POSTGRESQLPORT=4001
   PORT=4000
   MONGO_URI=mongodb+srv://default:[email protected]/?retryWrites=true&w=majority

2. Run the following commands in the main directory:

   npm run install-all
   npm run create-db
   npm run dev

Assignment 3:

Setup: Follow these steps to run the project:

1. Ensure you have a .env file in the backend folder.

   Sample .env file content in the backend folder:

   DB_USER=postgres
   DB_HOST=localhost
   DB_PASSWORD=YOUR_POSTGRES_PASSWORD
   DB_PORT=YOUR_POSTGRES_PORT->5432
   DB_DATABASE=cs3219_g47
   POSTGRESQLPORT=4001
   PORT=4000
   MONGO_URI=mongodb+srv://default:[email protected]/?retryWrites=true&w=majority
   ACCESS_TOKEN_SECRET=YOUR_ACCESS_TOKEN_SECRET
   REFRESH_TOKEN_SECRET=YOUR_REFRESH_TOKEN_SECRET
   AUTH_EMAIL=[email protected]
   AUTH_PASS=cs3219grp47

_{Note: YOUR_ACCESS_TOKEN_SECRET and YOUR_REFRESH_TOKEN_SECRET can be a random string}

2. Run the following commands in the main directory:

   npm run install-all
   npm run create-db
   npm run dev

3. The following are the roles and their access:

Role	View Question	Add Question	Delete Question	Edit Role (User and SuperUser)	Edit Role (Admin)
Unauthenticated user	No	No	No	No	No
User	Yes	No	No	No	No
SuperUser	Yes	Yes	Yes	No	No
Admin	Yes	Yes	Yes	Yes	No
SuperAdmin	Yes	Yes	Yes	Yes	Yes

Login Information for testing:

• User: [email protected], PW: 123456
• SuperUser: [email protected], PW: 123456
• Admin: [email protected], PW: 123456
• SuperAdmin: [email protected], PW: 123456

Assignment 4:

Setup: Follow these steps to run the project:

1. Ensure you have installed Docker Desktop
2. Run the following commands in the main directory:

   docker-compose down
   docker-compose up --build

3. Wait for the docker to fully initialise and connect to all databases before testing
4. Login Information for testing:
   • User: [email protected], PW: 123456
   • SuperUser: [email protected], PW: 123456
   • Admin: [email protected], PW: 123456
   • SuperAdmin: [email protected], PW: 123456

Assignment 5 and Project:

Setup: Follow these steps to run the project:

1. Ensure you have installed Docker Desktop
2. Run the following commands in the main directory:

   docker-compose down
   docker-compose up --build

3. Wait for the docker to fully initialise and connect to all databases before testing
4. Ensure that you use localhost instead of localhost:3000
5. Login Information for testing:
   • User: [email protected], PW: 123456
   • SuperUser: [email protected], PW: 123456
   • Admin: [email protected], PW: 123456
   • SuperAdmin: [email protected], PW: 123456

Setting up PostgreSQL Permissions

If you are not using the default PostgreSQL user (postgres) for your database operations, follow these steps to grant necessary permissions:

1. Open your terminal and enter the PostgreSQL command-line interface:

   psql -U postgres

2. Once you're in the PostgreSQL CLI, run the following command to grant superuser privileges to your user:

   ALTER USER your_username WITH SUPERUSER;

   Replace your_username with the actual username you're using for your PostgreSQL database.

These steps ensure that your user has the required permissions to perform CRUD (Create, Read, Update, Delete) operations in PostgreSQL.

Make sure to execute these commands with caution, especially when granting superuser privileges.