Skip to content

Commit

Permalink
Update README versions and deploy guide (#533)
Browse files Browse the repository at this point in the history
  • Loading branch information
StormFireFox1 authored Feb 7, 2022
1 parent a929851 commit f413551
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ACM at UCSD: Membership Portal UI

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

See [https://github.com/acmucsd/membership-portal](https://github.com/acmucsd/membership-portal) for the portal backend.

## Setup

**Install Node and npm**: [https://nodejs.org/en/](https://nodejs.org/en/). Builds are currently run on version `10.23.1`, but the LTS and Current versions should also work.
**Install Node and npm**: [https://nodejs.org/en/](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.17.0`, but any version should also work.
**Install yarn**: `npm install -g yarn`. Builds are currently run on `1.22.11`, but any version should also work.

## Running

Expand All @@ -18,9 +18,11 @@ See [https://github.com/acmucsd/membership-portal](https://github.com/acmucsd/me

**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/Zenhub, including a title, description, screenshots if applicable
- Add on Github, including a title, description, screenshots if applicable

- Label the applicable issue type.

Expand All @@ -45,4 +47,6 @@ When you merge, the branch will be deleted automatically.

- 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’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.

0 comments on commit f413551

Please sign in to comment.