Get Started
Introduction
What Frigear gives you, who it is for, and which path through these docs to take.
Most apps need the same parts before they do anything useful: sign-in, user accounts, an admin area, payments and
forms. Frigear gives you those parts as Nuxt 4 modules. You pick the modules you want, add
them to nuxt.config.ts and set their options.
These docs are for developers who build an app on the modules, and for people who change Frigear itself.
Want to build an app? Go straight to Installation. A few commands
give you a running Nuxt 4 app with sign-in, account pages and an admin area.
Prerequisites
None to read this page. Requirements lists the tools you install before you create an app.
Built for Nuxt 4. The modules and the base layer are Nuxt 4 modules (Nuxt
^4.6).
They expect the Nuxt 4 directory structure: app/ for app code and server/ for server code. Nuxt 3 is not
supported. Every setup snippet in these docs is a Nuxt 4 nuxt.config.ts.What Frigear gives you
- Modules. Each module adds one feature to your app, such as users or Stripe payments. It brings its routes, pages,
tables and composables. Modules are published to npm as
@frigear-nu/<module>. - Dependencies installed for you. A module installs the modules it depends on, so you usually add only the one you want.
- Starters. A starter is a ready-made project you copy to begin. It runs on the published modules and builds on its own, outside the Frigear repository.
- A reference app. The Frigear website app runs frigear.nu on these modules.
Two paths
- Build an app on Frigear. Stay in this tab. You copy a starter and work in your own project. Start with Installation.
- Contribute to Frigear. To change a module, the base layer or these docs, work in the Frigear repository. Start with the contribute overview, which also maps the repository's folders.
How these docs are organised
| Tab | Read it to |
|---|---|
| Get Started | Create an app, run it, sign in, add modules and deploy. You are here. |
| Guide | Understand the concepts, UX patterns and best practices behind the modules. |
| Modules | Look up the options, routes and hooks of each module. |
| Examples | Read the starters, the Frigear website app and step-by-step tasks. |
| Contribute | Work on the Frigear repository itself. |
Next steps
- Installation – check the requirements and create your first app.
- Architecture – see where your own code goes once the app runs.
- Modules – browse every module before you decide what to add.