ɣrɑχt

About the Project

Minimal blog template to capture your thoughts and ideas.

Built With

• Nuxt3
• Nuxt Content
• Nuxt Color Mode
• VueUse
• Tailwind CSS
• Tailwind Typography
• heroicons
• ESLint
• Prettier
• Pnpm
• Node.js v18
• husky
• Blood, sweat & tears

Getting Started

To get a local instance up and running follow these simple (or not, looking at you Node) steps.

Requirements & Installation

• Install Node.js v18 via n or Install Node.js v18 via nvm
• Install Pnpm
• Clone the repo git clone git@github.com:justpeterpan/amsterdamn.git
• Install dependencies with pnpm -i --shamefully-hoist (Even tho Nuxt3 documentation recommends installing dependencies with the --shamefully-hoist option it is highly discouraged by Pnpm itself)
• Install husky with pnpm run prepare
• Finally start the dev server on http://localhost:3000 pnpm run dev

Contributing

1. Clone Project
2. Create Feature Branch (git checkout -b feature/name-of-feature-or-post)
3. Commit changes
   • New Feature: git commit -m '✨ add new-feature-description'
   • New Post: git commit -m '🗒️ add new-post-title'
   • Bugfix: git commit -m '🐛 fix bugfix-description'
   • Refactoring: git commit -m '🎨 refactor component-or-sth-else-description'
   • Update: git commit -m '⬆️ update dependency-name-version'
   • Documentation: git commit -m '📝 update documentation-description'
4. Push to branch (git push origin feature/name-of-feature-or-post)
5. Create new pull request

Roadmap

• Refactor DamnHero-Component
• Update Readme
• Add Usage Information to Readme
• Add back to home-Button on Post-Pages
• Add Image-Component
• Add Navbar
• Refactor content subfolder structure
• Implement themes via config file
• Domain setup
• Add favicon
• Add title
• Add TypeScript ESLint config