Digging

Digging is a local-first music rating archive MVP. Users can rate songs and albums, add short notes and tags, revisit their archive, browse demo community profiles, and see simple taste-based recommendations.

MVP Scope

• Song and album ratings
• Short notes and tags
• Personal archive
• Public demo profiles
• Simple taste recommendations
• Local browser storage for the current user

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

Project Structure

app/
  app.vue                 # App shell and NuxtPage outlet
  error.vue               # Custom 404 and runtime error screen
  assets/scss/
    abstracts/            # Sass variables, mixins, functions
    base/                 # Global reset and base styles
    layouts/              # Layout-specific SCSS files
    pages/                # Page-specific SCSS files
  components/             # Reusable Vue components
    pages/                # Page-owned components grouped by route
  composables/            # Typed reusable state and helpers
  layouts/                # Nuxt layout shells
    components/           # Layout-owned components
  pages/                  # File-based Nuxt routes

Aliases

@styles      -> app/assets/scss
@components  -> app/components
@composables -> app/composables
@layouts     -> app/layouts

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

GitHub Pages Deployment

This project includes .github/workflows/deploy-github-pages.yml.

The workflow runs on pushes to main or master, and can also be started manually from GitHub Actions. It typechecks the project, builds Nuxt with the github_pages preset, uploads .output/public, and deploys it through GitHub Pages.

In GitHub repository settings, set Pages > Build and deployment > Source to GitHub Actions.

Check out the deployment documentation for more information.