DEVELOPERS.md

Nuxt Minimal Starter

Look at the Nuxt documentation to learn more.

Setup

Make sure to install dependencies:

# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install

Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

# pnpm
pnpm dev

# yarn
yarn dev

# bun
bun run dev

Production

Build the application for production:

# npm
npm run build

# pnpm
pnpm build

# yarn
yarn build

# bun
bun run build

Locally preview production build:

# npm
npm run preview

# pnpm
pnpm preview

# yarn
yarn preview

# bun
bun run preview

Check out the deployment documentation for more information.

Branch Strategy

We use a simple variation of Git and GitHub Flow for branch control.

Create and switch to a develop branch (one-time)

git checkout -b develop

Switch to a develop branch (every other time)

git checkout develop

Ensure develop is in sync with main

git merge main

Create a feature branch from develop

git checkout -b feature-branch develop

Make changes and commit

git add .

git commit -m "Implement new feature"

Developers

Submit a PR to merge your feature changes to the origin/develop branch

Maintainers

Merge feature branch back to develop

git checkout develop

git merge feature-branch

When ready for release, merge develop to master

git checkout master

git merge develop

Tag the release

git tag -a v1.0 -m "Release version 1.0"

git push origin v1.0