@nuxtus/nuxtus 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Craig Harman
+
+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.

package/README.md

@@ -0,0 +1,59 @@
+# Nuxtus
+
+A website w/ CMS boilerplate using [Directus](https://directus.io) for backend CMS and [Nuxt](https://nuxtjs.org) (w/ Tailwind CSS) for frontend.
+
+The purpose of this template is to be a quick-start for developing a website with Nuxt.js using Directus as the backend. The end result can be a static website or dynamically pull data from Directus depending on your preference.
+
+It also includes [nuxtus/cli]("https://github.com/nuxtus/cli") which provides a command line interface for quickly creating multiple index/detail pages from any Directus collections.
+
+- [Directus](https://directus.io)
+- [Nuxt](https://nuxtjs.org)
+  - [Tailwind CSS](https://tailwindcss.nuxtjs.org/)
+  - [Headless UI](https://headlessui.dev/)
+  - [HeroIcons](https://heroicons.com/)
+  - [Google Fonts](https://github.com/nuxt-community/google-fonts-module)
+  - [Nuxtus CLI]("https://github.com/nuxtus/cli")
+
+## Quickstart (preferred)
+
+```bash
+$ npx create-nuxtus app-name
+$ cd app-name
+```
+
+> Replace `app-name` with the name of your website or application.
+
+Your project will contain 2 folders server (Directus) and client (Nuxt). Run them as normal from within each folder:
+
+```bash
+~/server $ npx directus start
+~/client $ npm run dev
+```
+
+## Production deployment
+
+By default Directus is configured to accept CORS from any origin. Nuxtus suggests modifying this for your production deployment.
+
+## Manual setup
+
+Clone this repo onto your local machine, remove the remote git origin and add a new one.
+
+### Server (Directus) Setup
+
+```bash
+$ cd server
+$ npm i
+$ npx directus start
+```
+
+### Client (Nuxt) Setup
+
+```bash
+$ cd client
+$ npm i
+$ npm run dev
+```
+
+> For further instructions visit `[http://localhost:3000](http://localhost:3000)`
+
+

package/TODO

@@ -0,0 +1,4 @@
+
+Todo:
+  ☐ Handle fetch failures
+  ✔ Make a CLI for creating index/listing pages for Directus API @done(22-06-10 20:42)

package/changelog.md

@@ -0,0 +1,15 @@
+# Nuxtus
+
+## 1.0.0
+
+- Add `npx nuxtus-create` command
+
+## 0.0.2
+
+- Move to using [nuxt-directus package](https://nuxt-directus.netlify.app/)
+- Add @nuxtus/cli
+- Add .DS_Store to gitignore
+
+## 0.0.1
+
+Initial alpha release.

package/client/.env

@@ -0,0 +1,7 @@
+# Nuxt directus required values
+DIRECTUS_URL=http://localhost:8055
+# Nuxtus values
+# For now using email and password as nuxt-directus does not support token auth
+# NUXT_PUBLIC_DIRECTUS_TOKEN=UNSECURE_ACCESS_TOKEN
+NUXT_PUBLIC_DIRECTUS_EMAIL=admin@test.com
+NUXT_PUBLIC_DIRECTUS_PASSWORD=password

package/client/README.md

@@ -0,0 +1,42 @@
+# Nuxt 3 Minimal Starter
+
+Look at the [nuxt 3 documentation](https://v3.nuxtjs.org) to learn more.
+
+## Setup
+
+Make sure to install the dependencies:
+
+```bash
+# yarn
+yarn install
+
+# npm
+npm install
+
+# pnpm
+pnpm install --shamefully-hoist
+```
+
+## Development Server
+
+Start the development server on http://localhost:3000
+
+```bash
+npm run dev
+```
+
+## Production
+
+Build the application for production:
+
+```bash
+npm run build
+```
+
+Locally preview production build:
+
+```bash
+npm run preview
+```
+
+Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment) for more information.

package/client/app.vue

@@ -0,0 +1,6 @@
+<template>
+  <!-- Root layout, if you have multiple layouts create a layouts/ folder and delete this file -->
+  <div>
+    <NuxtPage />
+  </div>
+</template>

package/client/assets/css/tailwind.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

package/client/nuxt.config.ts

@@ -0,0 +1,29 @@
+import { defineNuxtConfig } from 'nuxt'
+
+// https://v3.nuxtjs.org/api/configuration/nuxt.config
+export default defineNuxtConfig({
+	buildModules: [
+		[
+			"@nuxtjs/google-fonts",
+			{
+				/* module options */
+			},
+		],
+		"@nuxtjs/tailwindcss",
+	],
+	modules: ["nuxt-directus"],
+	googleFonts: {
+		families: {
+			Inter: true,
+		},
+	},
+	tailwindcss: {
+		// Options
+		jit: true,
+	},
+	directus: {},
+	publicRuntimeConfig: {
+		directusEmail: "",
+		directusPassword: "",
+	},
+})

package/client/package.json

@@ -0,0 +1,19 @@
+{
+  "private": true,
+  "scripts": {
+    "build": "nuxt build",
+    "dev": "nuxt dev",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview"
+  },
+  "devDependencies": {
+    "@nuxtjs/google-fonts": "^1.3.0",
+    "@nuxtjs/tailwindcss": "^5.0.4",
+    "nuxt": "3.0.0-rc.1"
+  },
+  "dependencies": {
+    "@headlessui/vue": "^1.6.1",
+    "@heroicons/vue": "^1.0.6",
+    "nuxt-directus": "^2.0.1"
+  }
+}

package/client/plugins/directusLogin.ts

@@ -0,0 +1,12 @@
+export default defineNuxtPlugin(async (nuxtApp) => {
+	const config = useRuntimeConfig()
+	const { login } = useDirectusAuth()
+	try {
+		await login({
+			email: config.public.directusEmail,
+			password: config.public.directusPassword,
+		})
+	} catch (error) {
+		console.error(error)
+	}
+})

package/client/tailwind.config.js

@@ -0,0 +1,21 @@
+const defaultTheme = require("tailwindcss/defaultTheme")
+
+module.exports = {
+	content: [
+		`components/**/*.{vue,js}`,
+		`layouts/**/*.vue`,
+		`pages/**/*.vue`,
+		`composables/**/*.{js,ts}`,
+		`plugins/**/*.{js,ts}`,
+		`App.{js,ts,vue}`,
+		`app.{js,ts,vue}`,
+	],
+	theme: {
+		extend: {
+			fontFamily: {
+				sans: ["Inter var", ...defaultTheme.fontFamily.sans],
+			},
+		},
+	},
+	plugins: [],
+}

package/client/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  // https://v3.nuxtjs.org/concepts/typescript
+  "extends": "./.nuxt/tsconfig.json"
+}

package/create-app.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+
+const { execSync } = require("child_process")
+const path = require("path")
+const fs = require("fs")
+
+if (process.argv.length < 3) {
+	console.log("You have to provide a name for your app.")
+	console.log("For example :")
+	console.log("    npx create-nuxtus my-app")
+	process.exit(1)
+}
+
+const projectName = process.argv[2]
+const currentPath = process.cwd()
+const projectPath = path.join(currentPath, projectName)
+const git_repo = "https://github.com/nuxtus/nuxtus"
+
+try {
+	fs.mkdirSync(projectPath)
+} catch (err) {
+	if (err.code === "EEXIST") {
+		console.log(
+			`The folder ${projectName} already exist in the current directory, please try another name.`
+		)
+	} else {
+		console.log(error)
+	}
+	process.exit(1)
+}
+
+async function main() {
+	try {
+		console.log("Downloading files...")
+		execSync(`git clone --depth 1 ${git_repo} ${projectPath}`)
+
+		process.chdir(projectPath)
+
+		console.log("Installing dependencies...")
+		execSync("cd server && npm install")
+		execSync("cd client && npm install")
+
+		console.log("Removing unused files...")
+		execSync(
+			"npx rimraf ./.git ./create-app.js ./package.json ./package-lock.json ./TODO ./node_modules"
+		)
+		fs.rmdirSync(path.join(projectPath, "bin"), { recursive: true })
+		fs.appendFile(
+			".gitignore",
+			path.join("server", ".env") + "\n" + path.join("client", ".env"),
+			function (err) {
+				if (err) throw err
+				console.log("Saved!")
+			}
+		)
+
+		console.log(
+			"Nuxtus site is ready for use! Edit server/.env then start Directus."
+		)
+	} catch (error) {
+		console.log(error)
+	}
+}
+main()

package/package.json

@@ -0,0 +1,33 @@
+{
+	"name": "@nuxtus/nuxtus",
+	"description": "Directus/Nuxt boilerplate with Tailwind CSS.",
+	"version": "1.0.0",
+	"main": "create-app.js",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/nuxtus/nuxtus.git"
+	},
+	"keywords": [
+		"Directus",
+		"Nuxt",
+		"boilerplate",
+		"Tailwind",
+		"Tailwindcss"
+	],
+	"author": "Craig Harman",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/nuxtus/nuxtus/issues"
+	},
+	"homepage": "https://github.com/nuxtus/nuxtus#readme",
+	"bin": {
+		"create-nuxtus": "./create-app.js"
+	},
+	"publishConfig": {
+		"access": "public",
+		"registry": "https://registry.npmjs.org/"
+	},
+	"dependencies": {
+		"rimraf": "^3.0.2"
+	}
+}

package/server/.env

@@ -0,0 +1,66 @@
+####################################################################################################
+## General
+
+HOST="0.0.0.0"
+PORT=8055
+PUBLIC_URL="/"
+CORS_ENABLED=true
+CORS_ORIGIN=true
+
+####################################################################################################
+## Database
+
+DB_CLIENT="sqlite3"
+DB_FILENAME="./data.db"
+
+
+####################################################################################################
+## Rate Limiting
+
+RATE_LIMITER_ENABLED=false
+RATE_LIMITER_STORE=memory
+RATE_LIMITER_POINTS=25
+RATE_LIMITER_DURATION=1
+
+####################################################################################################
+## Cache
+
+CACHE_ENABLED=false
+
+####################################################################################################
+## File Storage
+
+STORAGE_LOCATIONS="local"
+STORAGE_LOCAL_DRIVER="local"
+STORAGE_LOCAL_ROOT="./uploads"
+
+####################################################################################################
+## Security
+
+KEY="3339424d-bc49-44dc-ac6c-5eed140f7b4d"
+SECRET="-3fcEkSym7BkfA5eLBOLb4EbMLpNF79E"
+
+
+ACCESS_TOKEN_TTL="15m"
+REFRESH_TOKEN_TTL="7d"
+REFRESH_TOKEN_COOKIE_SECURE=false
+REFRESH_TOKEN_COOKIE_SAME_SITE="lax"
+REFRESH_TOKEN_COOKIE_NAME="directus_refresh_token"
+
+####################################################################################################
+## Auth Providers
+
+AUTH_PROVIDERS=""
+
+####################################################################################################
+## Extensions
+
+EXTENSIONS_PATH="./extensions"
+
+####################################################################################################
+## Email
+
+EMAIL_FROM="no-reply@craigharman.com"
+EMAIL_TRANSPORT="sendmail"
+EMAIL_SENDMAIL_NEW_LINE="unix"
+EMAIL_SENDMAIL_PATH="/usr/sbin/sendmail"

package/server/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "nuxtus-server",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "directus": "^9.10.0",
+    "sqlite3": "^5.0.8"
+  }
+}

package/vetur.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+	projects: [
+		{
+			root: "./client", // root of your vue project (should contain package.json)
+			package: "./client/package.json", // Relative to root property, don't change this.
+			tsconfig: "./client/tsconfig.json", // Relative to root property, don't change this.
+		},
+	],
+}