Prepare to OSS

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