Blog

Description

Frontend: SvelteKit with Tailwind CSS
Backend: Rust actix-web

Despite SvelteKit being a full-stack framework, I still decided to adopt a separate front-end and back-end architecture for this blog project. I believe that this separation makes the project cleaner, reduces coupling, and aligns with modern development practices. Furthermore, I wanted to practice developing a purely back-end API.

As for the more detailed development approach, I plan to use Clean Architecture for the overall structure. Of course, such a small project may not necessarily require such complex design patterns, but I want to give myself an opportunity to practice them.

These will allow me to become more proficient in these modern development practices and leave a lot of flexibility and room for adjustments in the future.

For more information about the development process, you can check out the project board. As for the details of the architecture and convention, you can find them in the wiki.

Build & Development Setup

Prerequisites

Node.js (LTS version recommended)
pnpm - Package manager for frontend
Rust - For backend development
Podman (Optional) - For containerized deployment

Pre-commit Setup

This project uses pre-commit hooks to ensure code quality. To set up pre-commit:

Install pre-commit:
```
pip install pre-commit
```
Install the git hook scripts:
```
pre-commit install
```

The pre-commit configuration will automatically run:

Backend Rust code checking and formatting
Frontend linting and formatting
SQL schema preparation

Backend Setup

For detailed backend development setup, see backend/README.md.

Quick start:

Install sqlx CLI: cargo install sqlx-cli
Run database migrations: sqlx migrate run
Prepare SQL schema: cargo sqlx prepare --workspace
Run the server: RUST_LOG=debug cargo run

Frontend Setup

For detailed frontend development setup, see frontend/README.md.

Quick start:

Navigate to frontend directory: cd frontend
Install dependencies: pnpm install
Start development server: pnpm dev
Build for production: pnpm build

Full Project Setup

To set up the entire project:

Clone the repository
Set up pre-commit hooks (see above)
Set up backend (see backend/README.md)
Set up frontend (see above)
Start both servers for full-stack development

License

This project uses a combination of the MIT License and a custom license. Based on the MIT License, anyone is permitted to use the code. However, before deploying the code, they must first replace any information belonging to "me" or any content that could identify "me," such as logos, names, and "about me" sections.

2.9 KiB Raw Blame History