Skip to content

Latest commit

 

History

History
101 lines (84 loc) · 4.05 KB

README.md

File metadata and controls

101 lines (84 loc) · 4.05 KB
Raw

The official web page of pianist Sean Chen.

This is a monorepo of all the parts that make up sycpiano. Uses turborepo for task management. This website backend is an express app with a PostgreSQL database. Migration is done by dbmate. The frontend is built with react and built with vite. The admin panel uses react-admin and built with vite. Development is streamlined by vite. Use modern yarn for package management. Code is in typescript and styling is done in emotion. Deployment uses github actions. Service is persisted with PM2.

Getting Started

Make sure at least version 20 of Node.js is installed.

Env file

Setup a .env file with at least these entries:

DB_NAME=<database name, probably sycpiano, needed on prod>
DB_HOST=<production host, probably localhost/127.0.0.1, needed on prod>
DB_USER=<username>
DB_PASS=<password>
DB_PORT=<database port, needed on prod>
or
DATABASE_URL=<database connection url>

PORT=<http port number, needed on prod>
DEV_HTTPS_PORT=<https port number, optional>
DEV_HTTPS_CERT_PATH=<Dev to generated cert, optional>
CORS_ORIGINS=<comma separated list of allowed origins for backend requests, optional>
COOKIE_SECRET=<for signing session cookies, randomly generated (use openssl or something)>
PUBLIC_HOST=<For Stripe callback/admin URI>
GAPI_KEY_SERVER=<from google developer console>
GAPI_KEY_APP=<from google developer console, only needed to build app>
STRIPE_SECRET_KEY=<from stripe dashboard>
STRIPE_PUBLIC_KEY=<from stripe dashboard, only needed to build app>
STRIPE_WEBHOOK_KEY=<from stripe dashboard>
PRODUCTS_DIR=<absolute path to emailable assets>
IMAGE_ASSETS_DIR=<absolute path to image assets folder>
MUSIC_ASSETS_DIR=<absolute path to music assets folder>
SMTP_HOST=<smtp server>
SMTP_PORT=<465, 587, or 25>
SMTP_USERNAME=<smtp user>
SMTP_PASSWORD=<smtp pass>
DKIM_PRIVATE_KEY=<path to private PEM formatted key, should be at least 1024bit rsa>
GAPI_PRIVATE_KEY=<service account private key generated from google api console, copied from gapi-key.json>
GAPI_CLIENT_EMAIL=<service account email associted with above key>

Migrations

DBmate for migrations

$ yarn migrate -- [up|down|status]

Read DBmate README for more info.

Development

clone, run migration as written below, and then run:

$ yarn

Then, run dev.

$ yarn dev

N.B. on Windows, make sure you add %LocalAppData%\Yarn to your whitelist for antivirus and/or Windows Defender, or else installs take forever!

Production

Make sure all deps are up to date. Then:

$ yarn build

Automation on the server can be done by pm2.

Initializing the database

The website uses a PostgreSQL database, and connects to it using sequelize. Here are the steps for seeding the database:

  • Install PostgreSQL for your OS
  • Using the root user, open up a psql shell. On windows, the user's name will be postgres. On OSX, if you installed postgres through brew, then it'll be whatever your root user's name is. On linux, you'll need to switch to the postgres user by doing su - postgres in order to connect to the postgres server as the postgres user (i.e. the postgres user and the linux user have to match). One way to find out is to do psql -l and see who the owner of the postgres database is. Once you've figured out the root user, run this command:
$ psql -U <username>
  • In the postgres shell, create a new user
create role <username> with login password '<quoted password>'
  • In the psql shell, create a new database called sycpiano or whatever you wish, just remember it.
postgres=# create database sycpiano with owner <database_username>;

Admin

Admin is accessible by http://host.tld/admin. It is located in packages/admin.