README.md

All Things Web dot Dev

---

👷‍♀️ Working on the project

📋 Requirements

• Bun
• git

Requirements are checked int the make install but you can run make check-dependencies

📁 Directories

• website: the web application. Frontend + backend SSR

🛠️ Installation

To ease the DX on the project, you don't necessarly have to know about Bun or other command, instead we provide a Makefile that simplify it for you.

make install

This is going to install everything for you.

🔤 Environment variables

You need to cp website/.env.dist in website/.env.

🏃‍♂️ Running

Just run make

make serve

🤝 Contributing

Before any Pull Request please make sure to:

• make fmt to apply the coding standards
• make check to check for issues

this is enforced in the CI