Zokki's Softwareschmiede - Website Repository

Welcome to the official repository for the Zokki's Softwareschmiede website, zokki.net. This repository houses the source code for the website, which includes information about software development, blog posts, and various references.

Technologies Used

The website is built using Astro, a modern static site generator. Key technologies and languages include:

• Astro: The main static site generator for the website.
• Translated Routes: Custom implementation for handling translated routes without relying on JavaScript.
• Typescript: Used for scripting and enhancing functionality.
• Tailwind: CSS on another level.
• SCSS: The preferred style sheet language for styling.
• Custom Scripts: Specialized scripts for compressing Astro data attributes.

Getting Started

To get started with development or contribute to the project, follow these steps:

1. Clone the Repository:
   https

   git clone https://gitea.zokki.net/zokki/softwareschmiede.git
   

   
   ssh

   git clone gitea@zokki.net:zokki/softwareschmiede.git
   

2. Install Dependencies:

   cd softwareschmiede
   npm ci
   

3. Run the Development Server:

   npm run start
   

   This will start a local development server. Open your browser and navigate to http://localhost:4321 to view the website.

Project Structure

The project structure is organized as follows:

📦softwareschmiede/
 ┣ 📂.vscode/
 ┃ ┣ 📜extensions.json    # extension recommendations for vscode
 ┃ ┣ 📜launch.json        # lunch astro with debugger
 ┃ ┗ 📜settings.json      # vscode settings
 ┣ 📂@types/              # typescript global types
 ┣ 📂dist/                # build output from astro
 ┣ 📂integrations/        # all integrations important for astro
 ┣ 📂patches/             # patches to node_modules with patch-package
 ┣ 📂public/              # non-code, uncompressed assets
 ┣ 📂scripts/             # custom scripts
 ┣ 📂src/
 ┃ ┣ 📂components/        # reusable components
 ┃ ┣ 📂i18n/              # translations
 ┃ ┣ 📂layouts/           # page layouts - like wrapper
 ┃ ┣ 📂pages/             # html and ts for all pages
 ┃ ┣ 📂shared/            # utils
 ┃ ┗ 📂styles/            # SCSS styles
 ┣ 📜.eslintrc.cjs        # eslint(linter) configuration
 ┣ 📜.gitignore           # git ignore file
 ┣ 📜.prettierrc          # prettier(formatter) configuration
 ┣ 📜astro.config.ts      # astro configuration
 ┣ 📜LICENSE              # AGPL-3.0 License of the Website
 ┣ 📜package.json         # node.js package file
 ┣ 📜README.md            # project documentation (you are here)
 ┣ 📜tailwind.config.ts   # configuration for tailwind-css
 ┗ 📜tsconfig.json        # TypeScript configuration

Contributing

We welcome contributions from the community! If you find any issues or have improvements to suggest, feel free to open an issue.

License

AGPL-3.0 © Tim-Niclas Oelschläger