hackmcgill/hackerapi

🐓 API for registration, live-site

hackerAPI

API for registration, live-site

Builds

Master

Develop

How to use and contribute

See documentation here: https://docs.mchacks.ca

Deploy

hackerapi's Issues

Mongo Schema for Accounts / Users

Add route that updates Hacker status

Must follow the pipeline, unless explicit override is given.

View resume route

• User must provide hacker ID
• User must have permission (sponsor, admin)

_{Sent with GitHawk}

CSV Exports

As an admin or a sponsor, I want to be able to export information generated from my queries in order to manipulate it offline.

User Invitations

As an admin, I want to invite users to create accounts in order for them to participate in the hackathon.

Account Creation

As a hacker I would like to create an account to be able to apply to McHacks.

Investigate search routing

How do other services implement search + modify on their database?

Let’s investigate this and take inspiration from what others have done.

Upload resume route

• User uploads file
• User must provide hacker ID
• Account must be associated with hacker ID
• Upload file, then update location of file in account schema.

_{Sent with GitHawk}

View permissions route

As a user of this API, I should know which routes I have access to.

_{Sent with GitHawk}

Make it work.

Mongo Schema for Application

Hacker Status Update

As an Admin, I want to update a hacker status to inform them of their status

Generate dummy hacker data

Create endpoint for users to retrieve application data

Validation should verify that the user has the right permissions to view hacker's application

Create hacker application validations

Each user should only be able to apply once
Each field should have some sanitizations

Implement pagination

As a searcher of the database, I do not want to be given ALL of the results (since there could be too many). Instead, I want to receive only a subset of them, i.e. a page of results.

Document deployment process

Write the basics of deployment and system setup

Set up MongoDB hosting

• Set up MongoDB hosting for deployment, testing

Create endpoint for hackers to send application data

Child of #8

Build route to update hacker status to 'checked-in'

If there is no available space at the hackathon, the hacker must be:

accepted, and confirmed attendance

Else, the hacker can be at any stage of the pipeline beyond 'applied'.
You should be able to check in a Hacker via email. QR code encodes for email.

Draft Auth Architecture for RBAC

Base skeleton

Setup the base skeleton for the deployment on Kubernetes cluster on Google Cloud

Create preset hacker info access permission profiles

Create unit tests for current routes and check for correctness

The goal is to finish up unit tests for the rest of the current routes and methods by mid next week (August 8 ish). To do this, unit test setup will have to be created. The full list is as follows:

Unit test setup to be done:

• skill.test.util.js
• sponsor.test.util.js
• staff.test.util.js
• team.test.util.js
• volunteer.test.util.js

The unit tests will cover routes for:

• accounts
• auth
• hacker
  -team

The unit tests will cover services for:

• accounts
• auth
• database
• hacker
• permission
• skill
• team

The unit tests will cover middleware for:

• account validator
• hacker validator
• team validator
• validator helper
• account middleware
• auth middleware

The unit tests will cover controllers for:

• accounts
• auth
• hacker

Unit tests for models may be needed

Documentation Updates

Flesh out documentation

Create and update records in database based on form submission.

Team Application Access

As a team-member, I would like to access the team details in order to edit them.

Implement 2FA

https://github.com/speakeasyjs/speakeasy

Write GCP bucket upload service

Design and create routes for create functions

Design route grouping and create the routes for the creates for all models. This will happen after writing unit tests for the current methods (issue 31). The expectation is that filter will be complete by this time, and permissions will be fleshed out. The projected timeline for this is 2 weeks.

Integrate OAuth for login

Enabling OAuth support for passport.js to allow for logins with Google, Facebook, Twitter, Github, LinkedIn, etc....

Implement caching of routes

Performance enhancements

Hacker Check-In

As a staff member, I want to check hackers in so that I can keep track of who is at the hackathon.

Document Coding Standards

Complete the coding standards page on Notion

Create function to create/update default role binding for account

Used to be addDefaultHackerPermissions before authorization change.

Display user information

Will be taken from server

Set up GCP bucket acct for resume

User Email

As an admin, I would like to send emails to a list of people in order to inform them about hackathon related information

Create unique QR code for each hacker

Hackers need to be assigned QR codes for food and activity tracking throughout the event.

Authentication service

Ability to verify if account is valid or not.

Update error messages to be more informative

Update the error messages in different controllers. The goal is to create more descriptive messages that give more of an idea to what the error is and to make sure that we produce the same error message for the same error. For example, failure to retrieve a hacker due to an invalid id should produce the same error as a failure to retrieve a sponsor due to an invalid id except for replacing 'hacker' with 'sponsor'.

User filtering

As a User, I want to filter users by different criteria in order to perform bulk actions or view information.

Invite links to create account with tokens

• Users who create an account should be sent an email to create the specific profile of account that they signed up for.
• Examples:
  As a hacker, when I create an account, I should receive an email to confirm my account with a link to fill out my hacker profile. This link contains an auth token which is used to allow the given user to create ONE hacker profile with the associated account.

This is the same flow for all other types of accounts.

Flow for account creation:

[ create account ] -> [ get email to create hacker / sponsor / volunteer account ] -> [ click link, which contains auth token in URL ] -> [ front-end takes auth token and passes that to the API with account data ] -> [ backend validates token, creates account, makes token no longer valid ]

Staff-Hacker information update

As a staff member, I want to scan hackers' QR codes in order to update their information.

Set up Kubernetes service

Personal Application Viewing

As a hacker I would like to access my application in order to change the information on it.

Hacker Applications

As a hacker I would like to fill out and submit my application to McHacks to be able to potentially attend the Hackathon.

As a hacker I want to submit my hackathon details so that I can be judged.

Update Account and Hacker schemas to include new fields per MLH request

Hacker

Ethnicity: American Indian or Alaskan Native | Asian / Pacific Islander | Black or African American | Black or African American | Hispanic | White / Caucasian | Multiple ethnicity / Other (Please Specify) | Prefer not to answer
Major: String
Graduation year: Number
codeOfConduct: Boolean

Account

Birthdate: Date
Phone number: String

All fields are required.

Create Travis-CI integration