Blanq - The Nuxt (Hub) Starter

Blanq is a project to get a Nuxt app up and running as quick as possible. The project uses an opinionated list of packages, configurations, vendors and services. The idea is to be able just to replace some items in the app.config.ts and have the basis for your app set up.

Instead of having to always rewrite stuff like:

• Authentication
• Common Database schema and ORM setup
• Email sending
• File uploading
• Queues
• Stripe Payments / Products / Subscriptions

You have it out of the box, ready to be tweaked for your needs.

Development

Below are quick steps, but you can find the full documentation at:

Blanq Docs

Clone the repo into your project folder (./my-app)

git clone --depth=1 [email protected]:Eckhardt-D/blanq.git ./my-app

Change the remote origin to your own repo

cd ./my-app && git remote set-url origin <your-repo-url>

Install all the dependencies

pnpm install

Note

Currently some issues with native deps and cross-platform installs. Remove pnpm-lock.yaml and node_modules and try again if you run into issues.

Ensure you've copied and filled the necessary env vars from .env.example to .env.

Quick way to generate the better auth secret

node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

Most of the application boilerplate be easily updated via the app/app.config.ts file. Some things are hard coded though.

The application shell lives in app/pages/app/index.vue that is where you can implement the page you want to show after the user logs in. All pages that show this layout should be placed in the app/pages/app folder and use the dashboard layout and auth middleware. Pre-built settings pages live under app/pages/app/settings and use the settings layout and auth middleware.

Read the documentation and blog for more info on how to make changes and add your own features.

Start the local mail server

Please see This Repo for more information on how to start a local mailbox and sender. Alternatively you could always use your real MailChannels account API key and URL in the .env file.

docker run -d -p 8008:8008 mailchannels-dev

Start the app

This will automatically run the migrations for you if it's the first time you're running the app.

pnpm run dev