📚 Social Diversity for Children Foundation

Program registration platform for Social Diversity for Children Foundation.

Currently in development!

This project was generated with superplate.

🍁 F21 Team

Project Lead: Rickson Yang
Product Manager: Emily Nairn
Designers: Rebecca Ma, Vedant Patel
Developers: Matthew Geng, Neel Ismail, Amy Li, Greg Maxin, Brandon Wong, Kevin Zhang

😎 S21 Team

Project Lead: Eric Feng
Product Manager: Raewyn Tsai
Designers: Stacy Kwok, Christina Ru
Developers: Jason Huang, Soha Khan, Cindy Wang, Brandon Wong, Victor Yun, Mahad Zaryab

🔨 Project Architecture

1. NodeJS application powered by the Next.JS framework
2. Prisma ORM for PostgreSQL
3. Chakra UI for building accessible and responsive frontend components
4. i18next for internationalization and translations, specifically next-i18next
5. NextAuth.js for authentication
6. Service: Amazon S3 for file storage
7. Service: Amazon SES for email service
8. Service: Amazon Lambda and Amazon Cloudwatch for notification mailing
9. Service: Amazon Systems Manager for Storing one-time dynamic links
10. Service: Stripe for Class payment and product/coupon management
11. Service: Railway for deployment and database hosting
12. Service: Heroku for PostgreSQL DB hosting
13. Unstated Next for state management
14. SWR React Hook library for data fetching

⚙ Project Structure

.
├── .github
│   ├── workflows # Github workflows
│   └── pull_request_template.md # PR template
│
├── pages # Pages
│   ├── _app.tsx
│   ├── api # API routes
│   └── index.tsx
│
├── prisma # Prisma ORM
│   │── dev-seeds # seeding data for dev environment
│   │── migrations # migrations for production
│   │── schema.prisma # Prisma Schema
│   │── schema.sql # SQL Schema
│   └── seed.ts # utility to script dev environment
│
├── public
│   ├── icons # Icons
│   └── locales # Translations
│
├── models # Typescript types
│
├── src # Frontend tools
│   ├── components # Components
│   ├── definitions # Chakra
│   └── styles # CSS and Colours
│
├── terraform # Infrastructure as code for dev and prod
│   ├── environments # code separated by environments
│   └── modules # terraform modules for reuse
│
├── types # Dependency types
│
├── utils # Utility functions
│   │── containers # unstated-next containers
│   │── enum # enum utils
│   │── hooks # SWR API hooks
│   │── mail # SES mailing templates
│   │── request # API request utils
│   │── session # Session and authorization utils
│   │── time # time and date utils
│   │── toast # Chakra UI Toast msg utils
│   └── validation # Data/Input Validators
│
├── services # Third party services
│   ├── auth
│   ├── aws
│   ├── database
│   ├── nodemailer
│   └── stripe
│
# Misc individual files
├── .babelrc
├── .eslintignore
├── .env.sample # required env vars
├── .gitattributes
├── .gitignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
├── next-i18next.config.js
├── next-env.d.ts
├── next.config.js
├── package.json
├── tsconfig.json
└── yarn.lock

🔗 Local Dependencies

1. Heroku Client
2. NPM
3. Yarn

💻 Run Locally

Reset your database on Heroku and then deploy your database schema run (one-time):

# Drop all tables from current Heroku postgres database
heroku pg:reset -a <YOUR_APP_NAME>

# Deploy schema.sql to Heroku postgres
heroku pg:psql -a <YOUR_APP_NAME> -f prisma/schema.sql

# Regenerate Prisma schema and client
# optional - `npx prisma introspect`
npx prisma generate

# Seed your database with sample data
npx ts-node -O {\"module\":\"CommonJS\"} prisma/seed.ts

To run the application:

# Install dependencies
yarn

# Run locally
yarn dev

👨‍💻 Development

Linters run automatically as a pre-commit hook on edited .js, .jsx, .ts, .tsx files you edit and commit

To run the linters manually:

# Runs linting
yarn lint

# Correct  linting issues
yarn fix

✈️ Migration

NOTE: Before applying your migrations a production environment, ensure the diff via npx prisma db pull and npx prisma migrate status lines up with the migrations to be applied.

To migrate a database schema without losing data:

1. change both the schema.sql and schema.prisma file as required
2. run prisma migrate dev --name <DESCRIPTIVE_NAME> --create-only (this will require a shadow database)
3. after the migration is approved, run npx prisma migrate deploy to apply all new migrations

Baseline environment:

Baselining initializes a migration history for databases that contain data and cannot be reset - such as the production database. Baselining tells Prisma Migrate to assume that one or more migrations have already been applied. Run the following command to baseline for each of the required migration: prisma migrate resolve --applied <MIGRATION_FOLDER_NAME>

For more info, please reference: Adding Prisma Migrate to an existing project

🚢 Deployment

Deployments occur automatically on push to main and staging branches through Railway.

📝 License

MIT