March-mitsuki / youdoya

developing guide

• reqirement
  • nodejs v18+
  • yarn
  • docker
  • gui enviromention (electron only)

step 1 - prepare your enviroment

first, clone this repository

git clone https://github.com/March-mitsuki/youdoya.git

install dependencies

yarn install

init necessary enviroment file

yarn init-app

if you are using mac with Apple silicon(zsh), please run below command instead

yarn init-app-z

start docker compose service

docker compose up -d

migarate database in development mode

yarn db:migrate:dev

or you just want to testing but not migrate, run prisma db push directly instead

yarn run:prisma db push

step 2

start dev server

yarn dev:server

common step is over here, if

develop electron app

keep server running, and open a diffrent terminal, start webpack there.

this is to watch file changes and antomatically compile ts file to js.

yarn dev:electron:webpack

open another separate terminal, start electron app there

this is to restart electron app when webpack output js file changes

yarn dev:electron:app

remind: electron hot reload plugin customize with this PR catdad/electronmon#67

make a production version

production without docker (local mysql OR mariadb)