Skip to content

Latest commit

 

History

History
118 lines (92 loc) · 3.4 KB

README.md

File metadata and controls

118 lines (92 loc) · 3.4 KB
Raw

Dancefest Web (live)

Dancefest Web is Ontario Secondary School Dancefest's (OSSDF) Judging and Adjudication Platform. This webapp is utilized by OSSDF' judges to coordinate their performance scoring.

General Architecture

  1. NodeJS application powered by the Next.JS framework.
  2. Prisma ORM for PostgreSQL.
  3. Service: Amazon SES for outbound email service.
  4. Service: Heroku for application and database deploys.

Project structure

.
├── .github/workflows # Github deployment workflows
├── components # Individual application components
│   ├── Buttons.js
│   ├── Cards.js
│   ├── Inputs.js
│   ├── Layout.js
│   └── Modal.js
├── pages
│   ├── _app.js
│   ├── api # Serverless API routes
│   ├── event # /event/[id].js
│   ├── index.js # / -> Events
│   ├── login.js # /login
│   └── settings.js # /settings
├── prisma
│   ├── index.js # Prisma default export
│   ├── migrations
│   ├── schema.prisma # Prisma schema
│   └── schema.sql # SQL schema conforming to Prisma
│   └── seed.js # Prisma seeding scripts
├── public # Public outputs
│   ├── favicon.ico
│   └── vectors
├── styles
│   ├── components # Component styles
│   ├── globals.scss
│   └── pages # Page styles
# Misc individual files
├── .env.sample # Sample env file
├── .eslintrc.json
├── .gitignore
├── .prettierignore
├── .prettierrc.json
├── jsconfig.json
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

Run locally

Duplicate .env.sample to .env and replace with your appropriate environment variables.

To deploy your database schema run (one-time):

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

# Regenerate Prisma schema and client
npx prisma introspect && npx prisma generate

# Seeding the database with sample data
npx prisma db seed --preview-feature

To run the application:

# Install dependencies
yarn

# Run locally
yarn dev

Development

Linters are run automatically as a pre-commit hook on files you edit and commit.

To run the linters manually on the whole codebase:

# Runs linting
yarn lint

# Corrects linting issues
yarn fix

Future work: Per branch deploys for testing where you can open a PR against staging and comment /deploy in the PR!

Deploy

Deployment occurs automatically on-push to the Master and Staging branches. These deploys are handled by their respective Github Actions Workflows.

  1. Master Deploy: ossdancefest.com
  2. Staging Deploy: dancefest.dev

License

MIT