Skip to content

Commit

Permalink
chore: add license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Barbapapazes committed Aug 19, 2024
1 parent c3236e8 commit 27b5a79
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 53 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Estéban Soubiran <https://github.com/barbapapazes>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
72 changes: 19 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,41 @@
# Nuxt 3 Minimal Starter
# Gavarnie

Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
Pre-configured and ready-to-use features to help you start your full-stack Nuxt project **faster**.

[⛰️ View Gavarnie in action](https://gavarnie.barbapapazes.com)

Made with [Nuxt UI Pro](https://ui.nuxt.com), [NuxtHub](https://hub.nuxt.com), and [Nuxt Auth Utils](https://github.com/atinux/nuxt-auth-utils).

## Features

- 🎨 **Nuxt UI**: Create beautiful and responsive user interfaces in minutes with Nuxt UI
- 💻 **NuxtHub**: Access to a powerful set of full-stack features thanks to NuxtHub
- 🔑 **Nuxt Auth Utils**: Social authentication made easy with Nuxt Auth Utils and integrated with NuxtHub
- 🚪 **Login & Signup**: Built-in login and signup pages
- 🧑 **Profile**: Ready-to-use profile page, email change and account deletion.

## Setup

Make sure to install the dependencies:

```bash
# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install
```

Then, create a `.env` file with the content of `.env.example`. Update the values as needed.

## Development Server

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

```bash
# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev
```

## Production

Build the application for production:
This app is meant to be deployed on [Cloudflare](https://cloudflare.com). You can easily use [NuxtHub Admin](https://hub.nuxt.com/docs/getting-started/deploy#nuxthub-admin) to deploy it with ease.

```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

# yarn
yarn preview

# bun
bun run preview
```
## License

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
[MIT License](./LICENSE)

0 comments on commit 27b5a79

Please sign in to comment.