From e217e4a220c882bc385091ddfa1b91f23003483a Mon Sep 17 00:00:00 2001
From: Arthur DANJOU <arthurdanjou@outlook.fr>
Date: Mon, 1 Jul 2024 22:38:24 +0200
Subject: [PATCH] Prepare to OSS

---
 .env.example   |  20 +++++++++
 LICENSE        |  21 +++++++++
 README.md      | 114 ++++++++++++++++++++++++-------------------------
 nuxt.config.ts |   4 ++
 4 files changed, 100 insertions(+), 59 deletions(-)
 create mode 100644 .env.example
 create mode 100644 LICENSE

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..992a94e
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,20 @@
+# Wakatime
+NUXT_WAKATIME_USER_ID=
+NUXT_WAKATIME_CODING=
+NUXT_WAKATIME_LANGUAGES=
+NUXT_WAKATIME_OS=
+NUXT_WAKATIME_EDITORS=
+
+# Nuxt Sitemap
+NUXT_PUBLIC_SITE_URL=
+
+# Nuxt Hub
+NUXT_HUB_PROJECT_KEY=
+
+# Discord
+NUXT_DISCORD_ID=
+NUXT_DISCORD_TOKEN=
+NUXT_DISCORD_USER_ID=
+
+# Cloud files
+NUXT_PUBLIC_CLOUD_RESUME=
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..a869d87
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Arthur Danjou
+
+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.
\ No newline at end of file
diff --git a/README.md b/README.md
index 8bb7bf0..b6f3370 100644
--- a/README.md
+++ b/README.md
@@ -1,75 +1,71 @@
-# Nuxt UI Minimal Starter
+<div align="center">
 
-Look at [Nuxt docs](https://nuxt.com/docs/getting-started/introduction) and [Nuxt UI docs](https://ui.nuxt.com) to learn more.
+# [Portfolio 2024](https://arthurdanjou.fr/)
 
-## Setup
+🖼 My new portfolio built with `Nuxt`, `Nuxt Content`, `NuxtUI`, `Nuxt Studio`, `NuxtHub`
 
-Make sure to install the dependencies:
+</div>
+
+---
+
+## ⚒️ Tech stack
+
+- **UI** → [Vue.js](https://vuejs.org/)
+- **Framework** → [Nuxt.js](https://nuxtjs.org/)
+- **Content** → [Nuxt Content](https://content.nuxtjs.org/)
+- **Design System** → [NuxtUI](https://nuxtui.com/)
+- **CMS & Editing** → [Nuxt Studio](https://studio.nuxtjs.org/)
+- **Langage** → [Typescript](https://www.typescriptlang.org/)
+- **Deployment** → [NuxtHub](https://hub.nuxt.com/)
+- **Styling** → [Sass](https://sass-lang.com/) & [Tailwind CSS](https://tailwindcss.com/)
+- **Package Manager** → [pnpm](https://pnpm.io/)
+
+## 🍱 Adding content
+
+### Writings
+
+Add a new `.md` file in `/content/writings/` and follow the same pattern as the other articles. Add images
+in `/public/images/writings/`.
+
+### Uses
+
+Add a new item in `/content/uses`.
+
+## ⚡ Running locally
 
 ```bash
-# npm
-npm install
+# Installation (recommended for nuxt3)
+pnpm i --shamefully-hoist
 
-# pnpm
-pnpm install
-
-# yarn
-yarn install
-
-# bun
-bun install
+# Development server
+pnpm dev
 ```
 
-## Development Server
+Add a `.env` file with the following content:
 
-Start the development server on `http://localhost:3000`:
+```env
+# Wakatime
+NUXT_WAKATIME_USER_ID=...
+NUXT_WAKATIME_CODING=...
+NUXT_WAKATIME_LANGUAGES=...
+NUXT_WAKATIME_OS=...
+NUXT_WAKATIME_EDITORS=...
 
-```bash
-# npm
-npm run dev
+# Nuxt Sitemap
+NUXT_PUBLIC_SITE_URL=...
 
-# pnpm
-pnpm run dev
+# Nuxt Hub
+NUXT_HUB_PROJECT_KEY=...
 
-# yarn
-yarn dev
+# Discord
+NUXT_DISCORD_ID=...
+NUXT_DISCORD_TOKEN=...
+NUXT_DISCORD_USER_ID=...
 
-# bun
-bun run dev
+# Cloud files
+NUXT_PUBLIC_CLOUD_RESUME=...
 ```
 
-## Production
+## 📄 License
 
-Build the application for production:
-
-```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
-```
-
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+[MIT](./LICENSE) © Arthur Danjou
\ No newline at end of file
diff --git a/nuxt.config.ts b/nuxt.config.ts
index 41cf384..34111dd 100644
--- a/nuxt.config.ts
+++ b/nuxt.config.ts
@@ -76,6 +76,10 @@ export default defineNuxtConfig({
   nitro: {
     experimental: {
       openAPI: true
+    },
+    prerender: {
+      crawlLinks: true,
+      routes: ['/']
     }
   },