@effect-app-boilerplate

Setup

1. pnpm i from root
2. open a typescript file, and set VSCode's Typescript version to use the workspace version:
   • TypeScript: Select TypeScript version: Use workspace version

Run

Use the VSCode "Run Task", "Run UI". Or see below for running manually.

API, Models, Resources

a) pnpm build -w b) cd api && pnpm dev

Visit: http://localhost:3610/docs The API is also proxied in the frontend on /api

Frontend (Nuxt)

• cd frontend && pnpm dev -o

Visit: http://localhost:4000 API Docs: http://localhost:4000/api/docs

Notes

• Make sure you don't have the old Vue/Vetur vs code plugin installed, but the new ones only: "Vue.volar", "Vue.vscode-typescript-vue-plugin"

Helpful editor hints

Add to keybinds:

{
    "key": "ctrl+shift+i",
    "command": "editor.action.sourceAction",
    "args": {
        "kind": "source.addMissingImports",
        "apply": "first"
    }
}

Documentation

The project uses a git submodule (doc/) that references the GitHub wiki. Use effa wiki sync to initialize/update the documentation submodule.

Note: When using this boilerplate for a new project, update the submodule reference in .gitmodules to point to your project's wiki and reconfigure the git submodule with git submodule set-url doc <new-wiki-url>.

Framework documentation

WIP