My Website & Blog

Personal website and blog

A place to gather my thoughts on Software Engineering, homelab experiments and more.

_{Built with viele ☕️ by Josimar Silva.}

📖 Table of Contents

• 📝 Introduction
• 🏁 Getting Started
• 🛠️ Available Scripts
• 🧪 Testing
• 🚢 Releasing
• 🤝 Contributing
• 📄 License

📝 Introduction

This is a personal website and blog built with Next.js, TypeScript, and Markdown.

It serves as a platform for sharing thoughts on software engineering, homelab experiments, and other technical topics.

Key Features:

• Static site generation with Next.js for optimal performance and SEO
• Type-safe development with TypeScript
• Markdown-based content management for blog posts and book reviews
• Comprehensive test coverage with Jest and Playwright
• Responsive design with Tailwind CSS
• Progressive Web App (PWA) support
• High code quality standards with ESLint and SonarCloud
• Automated CI/CD pipeline with GitHub Actions

🏁 Getting Started

Follow these instructions to get the project running on your local machine.

Prerequisites

• Node.js (v24.x or later)

Installation

1. Clone the repository.

2. Navigate to the blog directory:

   cd blog

3. Install the dependencies using npm:

   npm install

   Alternatively, you can use the just command:

   just install

Running the Development Server

To start the development server, run:

just dev

The application will be available at http://localhost:3000.

🛠️ Available Scripts

This project uses just as a command runner for convenience.

• just dev: Starts the development server with Turbopack.
• just build: Builds the application for production.
• just start: Starts the production server (requires a build first).
• just check: Runs both linting and formatting checks.
• just lint: Lints the codebase using ESLint.
• just format: Formats the code using Prettier and fixes linting issues.
• just test: Runs all unit tests with Jest.
• just test-e2e: Builds the app and runs all end-to-end tests with Playwright.

🧪 Testing

The project includes both unit and end-to-end tests.

• Unit Tests: Run all unit tests using Jest:

  just test

• End-to-End Tests: Run all E2E tests using Playwright. This command will first build the application and then run the tests against the production build.

  just test-e2e

🚢 Releasing

Check the Releasing documentation for information about releasing to Cloudflare Pages.

🤝 Contributing

We welcome contributions to the blog project! If you're interested in contributing, enhancing the frontend, adding new features, or writing guest blog posts please see our Contributing Guidelines for more information.

📄 License

Copyright (C) 2025 Josimar Silva

Unless otherwise specified:

• Source Code: This project's code is licensed under the MIT License.
• Content: All content, including blog posts (__posts/), book reviews, and similar creative works, is licensed under the Creative Commons Attribution-Non Commercial 4.0 International (CC BY-NC 4.0) License.