UniverseTBD

Vue Template: vue-material-kit-master

Project setup

npm install

Compiles and hot-reloads for development

npm run dev
# If you want to do testing in LAN, eg your mobile phone
npm run dev -- --host 0.0.0.0

Spins up a docker container with hot reloading

docker-compose up
# must have docker and docker-compose installed

Compiles and minifies for production

npm run build

Check if the production build looks OK in your local environment.

npm run preview

Fork and Changes

---bash git remote add upstream https://github.com/universeTBD/universeTBD.github.io.git git fetch upstream git checkout main git merge upstream/main git push origin main

Typical scenario

git pull

git branch my-new-branch-name
git checkout my-new-branch-name

# ...
# modify source code
# ...

# make sure everything looks good locally:
npm run dev
npm run dev -- --host 0.0.0.0

# generate `docs/` files and add them to git:
./build.sh

# add new/modofied/removed files
git add modified-filename.example

# commit changes locally
git commit -m "version"

# push to github:
git push --set-upstream origin my-new-branch-name

This will create a new branch on github, which you can then make a pull request for on github. Once your branch is pulled into main, the universetbd.org website will be automatically updated within a few minutes.

Customize configuration

See Configuration Reference.