Merge branch 'master' of https://github.com/EvgenyWas/nuxt3-blog

README.md

@@ -1,65 +1,71 @@
-# Nuxt 3 Minimal Starter
+<div align="center">
 
-<img alt="GitHub License" src="https://img.shields.io/badge/NuxtJS-0f172a?logo=nuxtdotjs">
+# [Nuxt3 Blog](https://nuxt3-blog-mu.vercel.app/)
 
-Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+🖼 My pet project within mentoring at KMS Lighthouse
 
-## Setup
+</div>
 
-Make sure to install the dependencies:
+---
 
-```bash
-# npm
-npm install
-
-# pnpm
-pnpm install
-
-# yarn
-yarn install
-```
+## ⚒️ Tech stack
+<div>
+<img alt="Vue" src="https://img.shields.io/badge/VueJS-0f172a?logo=vuedotjs">
+<img alt="Nuxt" src="https://img.shields.io/badge/NuxtJS-0f172a?logo=nuxtdotjs">
+<img alt="Nuxt Content" src="https://img.shields.io/badge/NuxtContent-0f172a?logo=nuxtdotjs">
+<img alt="Vuetify" src="https://img.shields.io/badge/Vuetify-0f172a?logo=vuetify">
+<img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-0f172a?logo=typescript">
+<img alt="Vercel" src="https://img.shields.io/badge/Vercel-0f172a?logo=vercel">
+<img alt="PNPM" src="https://img.shields.io/badge/PNPM-0f172a?logo=pnpm">
+<img alt="MongoDB" src="https://img.shields.io/badge/MongoDB-0f172a?logo=mongodb">
+<img alt="Mongoose" src="https://img.shields.io/badge/Mongoose-0f172a?logo=mongoosedotws">
+</div>
 
-## Development Server
+- **Framework** → [Nuxt](https://nuxtjs.org/)
+- **Content** → [Nuxt Content](https://content.nuxtjs.org/)
+- **Design System** → [Vuetify](https://vuetifyjs.com/)
+- **Language** → [Typescript](https://www.typescriptlang.org/)
+- **Deployment** → [Vercel](https://vercel.com/)
+- **Package Manager** → [pnpm](https://pnpm.io/)
+- **Data Base** → [MongoDB](https://www.mongodb.com/)
 
-Start the development server on `http://localhost:3000`:
+## ⚡ Running locally
 
 ```bash
-# npm
-npm run dev
-
-# pnpm
-pnpm run dev
+# Installation (recommended for nuxt3)
+pnpm i --shamefully-hoist
 
-# yarn
-yarn dev
+# Development server
+pnpm dev
 ```
 
-## Production
+Add a `.env` file with the following content:
 
-Build the application for production:
+```env
+# Cloudinary
+NUXT_CLOUDINARY_CLOUD_NAME=...
+NUXT_CLOUDINARY_API_KEY=...
+NUXT_CLOUDINARY_API_SECRET=...
 
-```bash
-# npm
-npm run build
+# MongoDB
+NUXT_MONGODB_URL=...
 
-# pnpm
-pnpm run build
+# GitHub
+NUXT_GITHUB_CLIENT_ID=...
+NUXT_GITHUB_CLIENT_SECRET=...
 
-# yarn
-yarn build
-```
-
-Locally preview production build:
+# Google
+NUXT_GOOGLE_CLIENT_ID=...
+NUXT_GOOGLE_CLIENT_SECRET=...
 
-```bash
-# npm
-npm run preview
+# JWT
+NUXT_JWT_ACCESS_SECRET=...
+NUXT_JWT_REFRESH_SECRET=...
 
-# pnpm
-pnpm run preview
-
-# yarn
-yarn preview
+# Your app URL
+NUXT_PUBLIC_APP_URL=...
 ```
 
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+## 📄 License
+
+[MIT](./LICENSE) © Yauheni Vasiukevich