Skip to content

Commit

Permalink
docs: use automd in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Barbapapazes committed Oct 28, 2024
1 parent d915ae3 commit 7ee8c41
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 10 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Gavarnie

<!-- automd:fetch url="gh:barbapapazes/barbapapazes/main/automd/support-my-work.md" -->

> [!NOTE]
> If you find this project useful, please consider [supporting my work via GitHub Sponsors](https://github.com/sponsors/barbapapazes)! 💜
<!-- /automd -->

_[Read the announcement](https://soubiran.dev/posts/introducing-gavarnie-launch-your-saas-with-nuxt-and-assurance)_

Preconfigured and ready-to-use features designed to help you kickstart your full-stack NuxtHub project **quickly**.
Expand All @@ -22,24 +29,33 @@ Crafted with [Nuxt UI Pro](https://ui.nuxt.com/pro), [NuxtHub](https://hub.nuxt.
- 🚪 **Login & Signup**: Comes with built-in login and signup pages
- 🧑 **Profile**: Ready-to-use profile page, with email modification and account removal options.

## Setup
<!-- automd:fetch url="gh:barbapapazes/barbapapazes/main/automd/development.md" -->

Ensure to install the dependencies:
## Development

```bash
pnpm install
```
<details>

Next, set up a `.env` file based on the `.env.example` template. Modify the values as necessary.
<summary>Local development</summary>

## Development Server
- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`

Launch the development server at `http://localhost:3000`:
</details>

<!-- /automd -->

Set up a `.env` file based on the `.env.example` template. Modify the values as necessary.

Launch the development server with:

```bash
pnpm run dev
```

Open [http://localhost:3000](http://localhost:3000) in your browser to view the application.

## Production

This application is intended for deployment on [Cloudflare](https://cloudflare.com). You can effortlessly utilize [NuxtHub Admin](https://hub.nuxt.com/docs/getting-started/deploy#nuxthub-admin) for a smooth deployment process or use the CLI:
Expand All @@ -50,6 +66,10 @@ npx nuxthub deploy

You will also need a [Nuxt UI Pro License](https://ui.nuxt.com/pro) to build the application for production.

<!-- automd:fetch url="gh:barbapapazes/barbapapazes/main/automd/license.md" -->

## License

[MIT License](./LICENSE)
Published under the [MIT](./LICENSE) license.

<!-- /automd -->
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"db:generate": "drizzle-kit generate",
"postinstall": "nuxt prepare"
"postinstall": "nuxt prepare",
"automd": "automd"
},
"dependencies": {
"@nuxt/ui-pro": "^1.4.4",
Expand All @@ -31,6 +32,7 @@
"@iconify-json/ph": "^1.2.1",
"@iconify-json/simple-icons": "^1.2.10",
"@nuxt/eslint": "^0.6.0",
"automd": "^0.3.12",
"drizzle-kit": "^0.26.2",
"eslint": "^9.13.0",
"typescript": "^5.6.3",
Expand Down
101 changes: 101 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7ee8c41

Please sign in to comment.