zainw / notes

Atinotes

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

Setup

Make sure to install the dependencies:

# pnpm
pnpm install

Development Server

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

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 to build the application for production.

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Check out the deployment documentation for more information.

Deploy

With NuxtHub

You can deploy this template directy on your CloudFlare account with zero configuration with the NuxtHub Console and get a free .nuxt.dev domain.

npx nuxthub deploy

Once deployed, you can manage your project by running:

npx nuxthub manage

Then add the following environement variables:

ADMIN_PASSWORD=<your-password>
NUXT_SESSION_PASSWORD=<a-32-characters-long-password>
NUXT_UI_PRO_LICENSE=<your-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=<your-password>
NUXT_SESSION_PASSWORD=<a-32-characters-long-password>
NUXT_UI_PRO_LICENSE=<your-license>

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

nuxt build

The output directory is: dist/

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

That's all ✨

License

MIT - Sébastien Chopin