Introduction

This repository serves as an index of resources available as part of the Vode App Project, and doubles as a monorepo for convenience — a single clone to have everything in place. Vode App is a framework for building front-end applications using Vode.

Shoutout to @ryupold for creating Vode and thus enabling the creation of blazingly fast and maintainable front-end applications more easily than ever before.

Table of Contents

1. Resources
2. Documentation
3. DevOps
   1. Change Management
   2. Publish
      1. npmjs.org
      2. Custom registry

Resources

Resource	Description
Vode App Index (this repository)	An index of resources available as part of the Vode App.
Shared TypeScript Library	A shared TypeScript Library.

Documentation

<DOCUMENTATION>

Example

1. Create a package @vode-app/example-vode-app-backend using the @trs/hono-server template.

   bun create --no-install --no-git --force "@trs/hono-server@0.1.0-pre.18" "examples/example-vode-app-backend"
   

2. Create a package @vode-app/example-vode-app-frontend using the <VODE_APP_FRONTEND_TEMPLATE> template.

   bun create --no-install --no-git --force "@trs/hono-spa@0.1.0-pre.8" "examples/example-vode-app-frontend"
   

3. Run

   bun run clean; bun run build; bun run --cwd "examples/example-vode-app-backend" start
   

DevOps

# update all submodules
git submodule update --init --recursive

# view submodule status
git submodule status

# install all workspace/submodule dependencies
bun install

Change Management

1. Create a new branch for the change.
2. Make the changes and commit.
3. Bump the version in package.json.
4. Add an entry for the new version in CHANGELOG.md.
5. Pull request the branch.

common/

# add submodule
git submodule add ssh://git@git.chimps.quest:2200/vode-app/common.git common/

# update submodule
git submodule update --init --recursive common/

# it's recommended to
git -C common/ remote -v
git -C common/ remote rename origin upstream
git -C common/ remote add origin <FORK_URL>

# remove submodule
git submodule deinit -f common/
git rm -f common/
rm .git/modules/common/ -Force -Recurse