Getting Started

Getting Started

User installs the necessary dependencies for local development.

User clones the repository to their local machine.

User navigates into the mckinney-library-nuxt-app directory.

User creates a .env file inside the nuxt app folder with required environment variables.

DATABASE_URL="file:./mplf.db"

User installs the project dependencies using npm install.

User installs the Prisma client using 'npm install @prisma/client'.

User runs a Prisma generate using 'npx prisma generate'.

User runs the application locally using npm run dev.

User accesses the project at http://localhost:3000 in a browser.

This command might need to be ran too: npm install prisma --save-dev

Pages involved:

• Project root: mckinney-library-nuxt-app/
• Config: nuxt.config.ts, .env
• Entry point: app.vue

---

User roles:

Any team member contributing to development should follow this setup.
There are no role-based restrictions for getting started locally.

---

Notes:

• Node.js v18+ is required.
• Ensure Prisma migrations have been applied if you’re working with a local database. (The migrations should already be up on github so there shouldn't be a need to run migrations again)
• If issues occur with dependencies or the dev server, delete node_modules and package-lock.json and reinstall.