es-lynn / ip-protect-hackweek

IProtect

Requirements

• nvm
• node v16.8
• yarn v1.22
• Docker Desktop

Setup

1. yarn setup
2. modules/backend
   1. Copy .env.sample to .env
   2. yarn db:setup
   3. yarn db:start
   4. yarn db:reset
   5. yarn db:seed
   6. yarn start
3. modules/frontend
   1. Copy /env/.env.sample to /env/.env.local
   2. yarn start

Updating APIs

Whenever you make changes to the API on the backend, the interface on the frontend also needs to be updated. The project uses a combination of Swagger to generate the OpenAPI specifications, and swagger-typescript-api to generate the frontend client.

1. Make changes to API
2. Start your server and navigate to localhost:4000/swagger/docs
3. Test your API and ensure it's running correctly
4. Navigate to modules/frontend and run yarn build:api-client
5. The frontend API client should contain the new endpoint

ip-protect-hackweek's Issues

Invitation to join IProtect without joining a project (for users to create their own)

Redirect Netlify to /index.html

Description

• cannot directly route to specific links
• ie. https://dev-iprotect.netlify.app/home
• this is because Netlify only forwards /index.html

Verification

• Navigating to https://dev-iprotect.netlify.app/home should bring you directly to the home page

Bug: when dismissing a modal, the page throws error and becomes unresponsive

shows
Uncaught (in promise): undefined
Uncaught ReferenceError: process is not defined

Bulk removal of users in users page

Limited IP life time

Access indicators on home page for each project

Google Login

• Users should be able to login through their Google accounts

Tasks:

• Firebase credentials
• Frontend send JWT through API client
• Backend parse JWT and find user
• Backend validate JWT

Webpages page

Onboarding new users

GIVEN that I am an admin
WHEN I go to the users page
THEN I should be able to view an 'Invite new user' button

---

GIVEN that I have an 'Invite new user' button
WHEN I click on it
THEN I should be able to view a form with the following fields:

• Expiry date (optional): 1 hour, day, week
• User identifier
• 'Generate' button

---

GIVEN that I have filled up the invite user form correctly
WHEN I click the 'Generate' button
THEN

• I should be brought to a new page with the URL link
• a copy button
• a QR code with the link

---

GIVEN that I have a copy button link
WHEN I click on the copy button
THEN

• It should copy the link to my clipboard
• It should pop-up/toast the words 'Copied!'

QR code generator

Search on users page

Hide actions for non admins

Menu button to edit project in navigation bar

Home page

Alternate login methods (WOG AD? Techpass? Singpass?)

Improved invitation screen with more details

Mobile responsive

Specifications

• Min-width: 375px
• Max-width: 800px
• Beyond max-width: pad with empty spacing on both sides

Projects page

encryption of AWS secret at rest in DB

Users page

Show when IP was whitelisted and sort list of IP addresses