dev.md

DEV INFO

Setup repo for local development

1. Clone repo with all submodules via git clone --recurse-submodules https://github.com/Make-Your-School/mks-welcome.git. Consider using ssh link instead of https.
2. Install npm on your system. npm website
3. Run sudo npm install -g corepack and sudo npm i -g @quasar/cli to install the dependencies needed
4. Go into the repo folder with cd ./mks-welcome
5. Run yarn install dependencies of the project
6. Run quasar dev to start the application. Follow the link in the logs to open the page

add part

git submodule add https://github.com/XXXX

link collection

• list all mks repos https://github.com/search?q=user%3As-light+mks-&type=repositories

Install the dependencies

yarn
# or
npm install

Start the app in development mode (hot-code reloading, error reporting, etc.)

quasar dev

Lint the files

yarn lint
# or
npm run lint

Format the files

yarn format
# or
npm run format

Build the app for production

quasar build

to update the renderd version on github just push to the main branch. later we will change this so you can only diretly push into a dev branch. then there will be a release that merges this into main and with this merge triggers the deployment.

Customize the configuration

See Configuring quasar.config.js.

git submodules magic

for your locally: .git/modules/YourRePoName/config

[remote "origin"]
	url = http://github.com/

replace with

[remote "origin"]
	url = git@github.com:

git submodule foreach "(git pull)&"

git submodule foreach "(git checkout main; git push)&"

git submodule foreach "(git add .; git commit -a -m 'bulk-update readme.md')&"

git submodule foreach "(git commit -a -m 'bulk-update readme.md')&"

git submodule foreach "(git push)&"