Kaweees.github.io
My personal website and blog. Peeking under the hood, it uses Astro, a framework-agnostic static site generator, and Tailwind CSS, a utility-first CSS framework, to create a fast, modern, and responsive website, and is deployed on Netlify via Docker.
Built With
Getting Started
To get a local copy of the project up and running on your machine, follow these simple steps:
Prerequisites
Before attempting to build this project, make sure you have Docker, Node.js, pNpM, and taze installed on your machine.
Installation
To get a local copy of the project up and running on your machine, follow these simple steps:
- Clone the repo
git clone https://github.com/Kaweees/kaweees.github.io.git --recurse-submodules cd kaweees.github.io - Install the project dependencies
pnpm i - Start the development server
pnpm run dev
To update the projects modules, run the following commands:
pnpm taze -w
Usage
Docker
To build the project in a Docker container, run the following command:
docker-compose up -d # start the container in detached mode
docker-compose down # stop the container
Additionally, you can build the project in a Docker container using the
Available Commands
Here is a list of the commands provided in the scripts section of the
package.json file:
| Command | Description |
|---|---|
| pnpm i | Installs all the dependencies listed in pnpm-lock.yaml. |
| pnpm run preview | Serves the production build from the dist folder. |
| pnpm run format | Formats the codebase according to the defined code style guidelines. |
| pnpm run lint | Execute the linter to analyze the code for potential errors, style violations, or other issues. |
| pnpm run test | Runs the test watcher in an interactive mode. |
For more examples, please refer to the Go Command Documentation
Project Structure
Here is an overview of the main directories and their purposes:
src
├── lib
│ ├── components
│ │ ├── ui
│ │ │ ├── alert-dialog
│ │ │ │ ├── index.ts
│ │ │ │ └── alert.svelte
│ │ │ ├── button
│ │ │ │ ├── index.ts
│ │ │ │ └── button.svelte
│ │ │ └── ...
│ │ ├── navigation.svelte
│ │ ├── page-header.svelte
│ │ └── ...
│ └── utils.ts
├── routes
│ ├── +page.svelte
│ └── +layout.svelte
├── app.pcss
License
The source code for my website is distributed under the terms of the GNU General
Public License v3.0, as I firmly believe that collaborating on free and
open-source software fosters innovations that mutually and equitably beneficial
to both collaborators and users alike. See LICENSE for details
and more information.
