A digital nexus for cyberpunk-infused software development, documentation, and bleeding-edge projects.
PunkDomus is a content-focused platform built with Nuxt.js, designed to be a repository of knowledge at the intersection of code and cybernetics. This is a space to explore articles, technical documentation, and personal notes (HandNotes) through a retro-futuristic interface.
The project is structured to serve content from local Markdown files, providing a fast, static-generated experience, true to the Jamstack philosophy.
- Nuxt.js: The Intuitive Web Framework, used for Server-Side Rendering (SSR) and Static Site Generation (SSG).
- Vue.js: The progressive JavaScript framework that powers the user interface.
- @nuxt/content: A git-based Headless CMS that fetches and processes Markdown files from the
content/directory. - Docker: For containerizing the application, ensuring a consistent development and production environment.
To get a local instance of PunkDomus running, you'll need Node.js and npm installed.
git clone https://github.com/mrpunkdasilva/PunkDomus.git
cd PunkDomusConnect to the network and download the required packages.
npm installOnce the dependencies are installed, you can run the project in different modes.
To run the project with hot-reloading at http://localhost:3000:
npm run devThis is the recommended mode for development, as it reflects changes in real-time.
To build the application for production:
npm run buildTo start the production server after building:
npm run startTo generate a fully static version of the site:
npm run generateThe static files will be placed in the dist/ directory.
Alternatively, you can use Docker and Docker Compose to run the project in a containerized environment.
# Build and start the containers in detached mode
docker compose up --build -dThe application will be available at http://localhost:3000.
This project operates under the MIT License. See the LICENSE file for full details. Feel free to fork, modify, and distribute as you see fit.
End of Line.