Skip to content

Commit

Permalink
chore update README
Browse files Browse the repository at this point in the history
  • Loading branch information
risv1 committed Apr 23, 2024
1 parent a486800 commit 303d30b
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 68 deletions.
81 changes: 13 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,20 @@
# Nuxt 3 Minimal Starter
# Nuxt-Shadcn-Drizzle Starter

Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
This is a starter project for bootstrapping a Nuxt app with Shadcn-vue and Drizzle ORM, with Pinia for state
management.

## Setup

Make sure to install the dependencies:

```bash
# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install
```

## Development Server

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

```bash
# npm
npm run dev

# pnpm
pnpm run dev
## Stack

# yarn
yarn dev
Built using ![Nuxt Logo](public/icon-green.png)[Nuxt](https://nuxt.com/), ![Shadcn Logo](public/icon-shadcn.png)[Shadcn-vue](https://www.shadcn-vue.com/), ![Drizzle Logo](public/icon-drizzle.png)[Drizzle ORM](https://orm.drizzle.team/), ![TailwindCSS Logo](public/icon-tailwind.png)[TailwindCSS](https://tailwindcss.com/)

# bun
bun run dev
```

## Production

Build the application for production:

```bash
# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build
```

Locally preview production build:

```bash
# npm
npm run preview

# pnpm
pnpm run preview
## Setup

# yarn
yarn preview
1. Run `pnpm install` to install all dependencies.
2. Create a .env file, and add `DB_URL`, `JWT_SECRET` respectively.
3. Setup your preferred SQL database in `database/`, this example uses Postgres
4. Run `docker compose up -d` if an instance is preferred.
5. Run `pnpm dev` to start the application

# bun
bun run preview
```
## License

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
Nuxt-Shadcn-Drizzle Starter is licensed under the [MIT License](https://github.com/risv1/nuxt-shadcn-drizzle-starter/blob/main/LICENSE).
Binary file added public/icon-drizzle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/icon-shadcn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/icon-tailwind.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 303d30b

Please sign in to comment.