wishbone

🏡 A landing page showcasing the services and projects of an architectural company.

Explore the docs »

Usage · Report Bug · Request Feature

📖 Table of Contents

1. 🏛 About The Project
2. 🛠 Built With
3. 🚀 Getting Started
   • 📋 Prerequisites
   • 💾 Installation
4. 💡 Usage
5. 🤝 Contributing
6. 📄 License
7. ✉️ Contact

🏛 About The Project

wishbone is a modern landing page built for an architectural company.
It showcases company services, projects, and provides a clean, interactive interface for visitors.

(back to top)

🛠 Built With

• TypeScript — main programming language
• Webpack 5 — module bundler
• Babel — transpiling modern JS/TS
• Pug — HTML templating
• Sass / CSS — styling
• Jest — testing framework
• LightningCSS — CSS optimization

(back to top)

🚀 Getting Started

Follow these steps to set up the project locally.

📋 Prerequisites

• Node.js >= 18
• pnpm

💾 Installation

1. Clone the repository:

git clone https://github.com/toptuk49/wishbone.git
cd wishbone

2. Install dependencies:

pnpm install

3. Run development server:

pnpm dev

4. Build production files:

pnpm build

5. Run tests:

pnpm test:src    # test source files
pnpm test:config # test config files
pnpm test:utils  # test utility files

(back to top)

💡 Usage

• Open the development server to view the landing page

• Make changes in src folder

• Run tests using pnpm test:src (or other test scripts for config/utils)

(back to top)

🤝 Contributing

Use conventional commits (feat:, fix:, docs:, etc.)

1. Fork the Project

2. Create your Feature Branch (git checkout -b feature/)

3. Commit your Changes (git commit -m 'feat: add ')

4. Push to the Branch (git push origin feature/)

5. Open a Pull Request

(back to top)

📄 License

Distributed under the GNU General Public License. See LICENSE for details.

(back to top)

✉️ Contact

Anton Kuznetsov - GitHub

Project Link: https://github.com/toptuk49/wishbone

(back to top)