membership-portal

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

membership-portal

★ 17 Open GitHub ↗

REST API for the UC San Diego ACM chapter's membership portal.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## membership-portal-api &nbsp; [![CircleCI](https://circleci.com/gh/acmucsd/membership-portal/tree/master.svg?style=svg)](https://circleci.com/gh/acmucsd/membership-portal/tree/master)
REST API for the UC San Diego ACM chapter's membership portal. This is an open-source project, made for members by members, and we welcome any contributions! If you're interested in using the API for your own project and/or contributing, check out our guide [here](https://github.com/acmucsd/membership-portal/blob/master/.github/CONTRIBUTING.md).

### Build Instructions
`npm install` may not work properly due to version incompatibilities. Feel free to use `yarn ...` instead of `npm run ...`.

1. Clone the repository: `git clone https://github.com/acmucsd/membership-portal`.
2. Navigate to the directory: `cd membership-portal`.
3. Install PostgreSQL. See [installation instructions below](#installing-postgres).

if(`npm install` works fine):

4. Install the necessary dependencies: `npm install`. For Windows users, see [specific build instructions below](#windows-build-instructions).
5. Create a new `.env` file using [`.env.example`](https://github.com/acmucsd/membership-portal/blob/master/.env.example) as a template: `cp .env.example .env`.
6. Fill out the `.env`. See the [example file below](#sample-env).
7. Run the containerized service(s) (e.g. Postgres): `docker-compose up -d`.
8. Initialize the database: `npm run db:migrate`.
9. Populate the database: `npm run db:seed`.
10. Start the Node app: `npm run dev`.

if(`npm install` does not work):

4. Install yarn first, it is a package manager (you can find it at https://yarnpkg.com). After that, install the necessary dependencies using: `yarn install`.
5. Create a new `.env` file using [`.env.example`](https://github.com/acmucsd/membership-portal/blob/master/.env.example) as a template: `cp .env.example .env`.
6. Fill out the `.env`. See the [example file below](#sample-env).
7. Run the containerized service(s) (e.g. Postgres): `docker-compose up -d`.
8. Initialize the database: `yarn run db:migrate`.
9. Populate the database: `yarn run db:seed`.
10. Start the Node app: `yarn dev`.

#### Installing Postgres
Even though our actual Postgres instance runs in a Docker container, we need to install Postgres to install the official `pg` Node package. MacOS and Linux users can install Postgres via [Homebrew](https://brew.sh), and Linux users can use `apt`. Windows users will need to download the Postgres 17.6 installer，run the installer, and add the Postgres bin to the PATH environment variable.

#### Windows Build Instructions
1. Run the Windows Powershell as administrator.
2. Install build tools to compile [native Node modules](https://www.npmjs.com/package/windows-build-tools#examples-of-modules-supported): `npm install -g windows-build-tools`.
3. Rerun `npm install` in a separate command prompt window.

#### Sample `.env`
```
RDS_HOST=localhost
RDS_PORT=5432
RDS_DATABASE=membership_portal
RDS_USER=acmucsd_dev
RDS_PASSWORD=password

AUTH_SECRET=secret

CLIENT=localhost:8000
```
**Note**: For Windows users, `localhost` won't work&mdash;you'll need to set `RDS_HOST` to [the Docker Machine's IP address](https://docs.docker.com/machine/reference/ip/).

### Useful Commands
+ `docker-compose up -d` to configure and run any required services
+ `npm install` to install the necessary dependencies
+ `npm run dev` to run the Node app with [Nodemon](https://nodemon.io/) and [ts-node](https://github.com/TypeStrong/ts-node)
+ `npm run build` to compile the code to JavaScript
+ `npm run lint` to lint the Node app with [ESLint](https://eslint.org/) (without `--fix`)
+ `npm run lint:fix` to fix the simple linter issues automatically
+ `npm run test` to run the test suite with [Jest](https://jestjs.io/)
+ `npm run db:migrate` to run any new database migrations
+ `npm run db:rollback` to roll back the last database migration
+ `npm run db:seed` to populate the database with seeds
+ `npm run db:unseed` to completely clear the database
+ `docker exec -it rds.acmucsd.local psql -U [RDS_USER] -d [RDS_DATABASE]` to access Postgres (`RDS_XYZ` from `.env`).

Take a look at [`package.json`](https://github.com/acmucsd/membership-portal/blob/master/package.json) for the actual commands.

### Testing Information
After having executed `npm run db:seed`, `tests/Seeds.ts` will have been used to generate sample data. For all testing accounts, the password is `password`. To test basic features of the portal, `acm@ucsd.edu` can be used for the demo admin account, and any  seed email (e.g. `s3bansal@ucsd.edu`) can be used for a demo member account.

For testing out the different portal roles, use the email `acm_[role]@ucsd.edu`, such that `[role]` is replaced with any of the following terms:
* `restricted` - User has been blocked from appearing on the leaderboard, although their account is still valid.
* `standard` - The default user role for all member accounts.
* `staff` - User is able to check in to events as a staff member.
* `admin` - User has full permissions to administrate the portal and store.
* `marketing` - User is able to create and edit events.
* `store_manager` - User is able to administrate store, including modifying collections, items, options, stock, and pricing.
* `store_distributor` - User is able to execute store distributions, including viewing and fulfilling orders for each pickup event.

For testing out the store, use the email `acm_store@ucsd.edu`, as the majority of demo orders will be placed with this account.

Some tests may fail if your local PostgreSQL version differs from the CI environment (see .circleci/config.yml).
Try running tests with the Dockerized Postgres image.

### Upgrading to Latest Version
The first iteration of the membership portal is a JavaScript app written in 2019. The second and latest iteration, written 2020, is a TypeScript app built with better reliability and error handling, stronger concurrency guarantees, and a smoother development experience in mind, and includes a number of breaking changes at the API and database levels. For a more concrete list of improvements, see [acmucsd/membership-portal#115](https://github.com/acmucsd/membership-portal/pull/115).

#### API Breaks and Changes
+ `GET /auth/resetPassword`: renamed to `/auth/passwordReset`
+ `POST /auth/resetPassword`: renamed to `/auth/passwordReset`
+ some routes (e.g. events search) accept optional auth tokens for more detailed responses
+ `POST /user/bonus`: renamed to `/admin/bonus`
+ `POST /user/milestone`: renamed to `/admin/milestone`; `resetPoints?: boolean` has been replaced in the request body by `points?: number`
+ `GET /store/collection/:uuid`: `merchandise` has been renamed in the response body to `items`
+ `GET /store/merchandise`: deleted
+ passwordChange field is breaking change (see Auth/UserControllerRequests)
+ `POST /user/picture/:uuid`: the UUID parameter is optional
+ `GET /attendance/:uuid?`: the `attendance` field in the response body has been renamed `attendances`
+ `POST /attendance/attend`: no longer reachable, requests should be made to `/attendance`
+ merch store has been completely reworked

#### To Upgrade
1. Update the app to the latest release of the first iteration ([`v1-latest`](https://github.com/acmucsd/membership-portal/releases/tag/v1-latest)).
2. Manually run this SQL script ([`0000-sequelize-to-typeorm.sql`](https://github.com/acmucsd/membership-portal/blob/master/migrations/0000-sequelize-to-typeorm.sql)).
3. Update the app to the latest release ([latest](https://github.com/acmucsd/membership-portal/releases/latest)).

membership-portal

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README