Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/atinux/atinotes

An editable website with universal rendering on the edge.
https://github.com/atinux/atinotes

cf-pages esr nuxt nuxt-template nuxt-ui nuxt-ui-pro nuxthub vue vue3 workers

Last synced: 6 days ago
JSON representation

An editable website with universal rendering on the edge.

Host: GitHub
URL: https://github.com/atinux/atinotes
Owner: atinux
License: mit
Created: 2023-02-08T16:29:37.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-12-10T11:57:49.000Z (18 days ago)
Last Synced: 2024-12-16T11:47:29.761Z (12 days ago)
Topics: cf-pages, esr, nuxt, nuxt-template, nuxt-ui, nuxt-ui-pro, nuxthub, vue, vue3, workers
Language: Vue
Homepage: https://notes.atinux.com
Size: 1.62 MB
Stars: 164
Watchers: 4
Forks: 9
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Save your Markdown notes online with Atinotes 🖌️

Read more on https://notes.atinux.com

[![Nuxt UI Pro](https://img.shields.io/badge/Made%20with-Nuxt%20UI%20Pro-00DC82?logo=nuxt.js&labelColor=020420)](https://ui.nuxt.com/pro)

[![Deploy to NuxtHub](https://hub.nuxt.com/button.svg)](https://admin.hub.nuxt.com/new?template=atinotes)

## Setup

Make sure to install the dependencies:

```bash
# pnpm
pnpm install
```

## Development Server

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

```bash
npm run dev
```

Copy the `.env.example` to `.env` and update the variables to your own.

## Production

Note that you need a [Nuxt UI Pro license](https://ui.nuxt.com/pro) to build the application for production.

Build the application for production:

```bash
npm run build
```

Locally preview production build:

```bash
npm run preview
```

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

## Deploy

### With NuxtHub

You can deploy this template directy on your CloudFlare account with zero configuration with the [NuxtHub Console](https://console.hub.nuxt.com) and get a free `.nuxt.dev` domain.

```bash
npx nuxthub deploy
```

Once deployed, you can manage your project by running:

```bash
npx nuxthub manage
```

Then add the following environement variables:

```
ADMIN_PASSWORD=
NUXT_SESSION_PASSWORD=
NUXT_UI_PRO_LICENSE=
```

Once saved, the deployment will be updated with the new environment variables.

### Manually on Cloudflare Pages

Once you created your GitHub repository with this template, you can connect to it, then add those env variables:

```
ADMIN_PASSWORD=
NUXT_SESSION_PASSWORD=
NUXT_UI_PRO_LICENSE=
```

Then, setup the build command on CloudFlare Pages to be:

```bash
nuxt build
```

The output directory is: `dist/`

Next, you need to link a KV namespace to the deployment, the binding should be named `KV`.

![KV example on CloudFlare](https://github.com/Atinux/atinotes/assets/904724/3c35a422-b646-41b9-9337-cc7de06f0d14)

That's all :sparkles:

## License

[MIT](./LICENSE) - Sébastien Chopin