acmucsd / membership-portal-ui Goto Github PK

🔷 React Front End for ACM UCSD's Membership Portal

HTML 0.60% JavaScript 0.49% TypeScript 78.68% Less 20.22%

membership-portal-ui's Introduction

ACM at UCSD: Membership Portal UI

This is the frontend repository for the ACM at UCSD membership portal. The live portal is viewable at: https://members.acmucsd.com.

See https://github.com/acmucsd/membership-portal for the portal backend.

Setup

Install Node and npm: https://nodejs.org/en/. Builds are currently run on version 14.18.2, but the LTS and Current versions should also work.

Install yarn: npm install -g yarn. Builds are currently run on 1.22.11, but any version should also work.

Running

Clone the repo: Run git clone https://github.com/acmucsd/membership-portal-ui.git in a terminal.

Install packages: Run yarn or yarn install to install the node modules.

Run the portal: Run yarn start to run the portal with the development environment variables. The page will be available at localhost:8080.

Currently the portal is deployed as-is using yarn build on Netlify.

Issues

Add on Github, including a title, description, screenshots if applicable
Label the applicable issue type.
If you’d like to work on that specific issue, assign yourself.
If not, it will get assigned during development meetings.

PRs

Every PR should have a corresponding issue it’s tied to. You can link by using the phrase “Resolves #XX.” in the PR description, or in the GitHub sidebar. Assign yourself to the PR.
Tag the PR as “PR: Needs Review” and request a review from the portal PM.
If the PR is approved, go ahead and merge the PR into the repo.
If the PR isn’t approved, check the comments for feedback / suggested changes. When you merge, the branch will be deleted automatically.

Coding

When working on the portal, start by creating a new branch based on master. Add all commits to this branch, and then you can create a PR from there.
There should be one feature/bugfix per branch.
If you’re working on the portal in parallel with someone else and end up with PR conflicts / merge issues, contact the portal PM via the Discord server.
If you are working on an overarching feature/refactor, make a separate branch from master and try your best to rebase to master whenever applicable.

membership-portal-ui's People

Contributors

Stargazers

Watchers

Forkers

stonet2000 paulpan05 resummit falafel72 annsudhart cgcha froggerson techonomics69 jongmal duanwilliam farisashai trevorkw7 zhikky janzenmolina

membership-portal-ui's Issues

Dropdown not fixed with rest of banner

Ant design is weird sometimes

Should be similar to #5. Also, don't worry about giving it functionality. That'll be done in the registration page issue. This issue should mainly cover laying out the component, anywhere where you would usually put a function call (such as submitting the form) should just be replaced with a prop

Make Profile Form

Good luck

Remove Travis

Create sign in form

Transition from TravisCI to CircleCI

Profile pic upload

Create log in container

This is the PR where you'll actually give your log in form component made in #5 some functionality

Create event check in container

Add actions so that the event check in container actually checks you into events

Populate leaderboard container

Update packages with customize-cra and babel import

https://ant.design/docs/react/use-with-create-react-app

Update README

Our coverage badge literally says 100% coverage because it's for a branch that no longer exists woops. Also should probably include a guide on how this is deployed.

Event Check In Doesn't Work with Enter Key

Reorganize components

Let's nest our components so it's not as ugly

Separate development and production

Create events container

Implement auth in frontend

client will store jwt (in cookie) that will be used for requests to server

Add Google as a method of signing in

Create admin form

Write tests

Revisit after fall quarter.

Create about page

Get profile information with API

Create navbar

Refresh leaderboard based on timed interval

Update register form major fetching from static file to API call

The registration form currently allows users to input anything into the "Majors" section

Create sidebar item component

Create registration container

Handle users who forget their password

Low priority, I'll probably add labels to issues for priority later. Just handle this however you want, it can be through sending them an email or a text message for verification. You can also have them meet with a Board member to be able to change their password? The choice is yours but don't worry about this unless you have absolutely nothing else to do

Create global styles files

Create leaderboard list item component

Oh wow seems kind of similar to something else you worked on huh

Set up travis-ci

Validate email component

Add ESLinting

Why

We can solve coding bugs that can lead to problems not easily checked by us, and we can combine it with prettier to ensure proper code styling

How

Use Airbnb's ESLint config and make sure it works with prettier.

Note

We should NOT enforce eslint for now since we're in crunch time, but after the portal ships we should prohibit code from being pushed without passing eslint (as a commit config / or push hook or something)