Skip to content

Commit

Permalink
chore: remove useless files and add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
admin authored and admin committed Jun 16, 2024
1 parent f5d819a commit d9dd36b
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# about.bdx.town

## Overview

**about.bdx.town** is a lightweight website designed to showcase the various services offered by bdx.town. Despite leveraging technologies typically associated with resource-heavy websites, about.bdx.town is meticulously optimized to ensure that the compiled and hosted site remains under 25KB.

## Features

- **Service Overview:** Comprehensive presentation of the different services provided by bdx.town.
- **Optimized Performance:** Designed to be lightweight and fast, utilizing advanced web technologies efficiently.
- **Modern Design:** Uses Canaille, the React-based design system of bdx.town, for a sleek and user-friendly interface.

## Technologies Used

- **React:** A popular JavaScript library for building user interfaces.
- **Canaille:** The custom design system of bdx.town, built with React to ensure consistency and usability.
- **Vite:** For bundling and optimizing the site’s assets.

## Getting Started

### Prerequisites

To run or contribute to this project, you need to have the following installed:

- Node.js (v14 or higher)
- Yarn (v4.0.2 or higher)

### Installation

1. Clone the repository:

2. Install dependencies:

```bash
yarn install
```

### Build

To compile the project for production:

```bash
yarn build
```

This will create a `dist` directory containing the optimized files.


## Contact

For any inquiries or issues, please contact the project maintainers at [[email protected]](mailto:[email protected]).

---

Thank you for using about.bdx.town! We hope you find it helpful and easy to navigate.
Binary file removed public/mail-icon.jpg
Binary file not shown.
Binary file removed public/mail.jpg
Binary file not shown.

0 comments on commit d9dd36b

Please sign in to comment.