Skip to content

Commit 8b529e5

Browse files
committed
Add build commands
1 parent 2eae95f commit 8b529e5

File tree

4 files changed

+82
-10
lines changed

4 files changed

+82
-10
lines changed

README.md

Lines changed: 82 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,92 @@
66

77
--
88

9-
## Project Structure
9+
## Description
10+
11+
- BINABOX is a platform for exploring NFT collections
12+
- Users can check rarity, view products, and access blog content
1013

11-
- `src/assets/icons` - SVG icons for your project
12-
- `src/assets/images` - Images for your project
13-
- `src/styles` - SCSS stylesheets
14-
- `src/data` - JSON data
15-
- `src/templates/layouts` - Twig layouts
16-
- `src/templates/partials` - Twig partials
14+
## Features
15+
16+
- Browse NFT catalog with images
17+
- Read articles in blog section
18+
- Connect wallet and Whitelist
19+
- Interactive FAQ and Team section
1720

1821
---
1922

2023
## Installation
2124

2225
1. Clone the repository:
23-
```bash
24-
git clone <your-repo-url>
25-
cd bro1
26+
```bash
27+
git clone <your-repo-url>
28+
cd bro1
29+
```
30+
2. Install dependencies:
31+
```bash
32+
npm install
33+
```
34+
35+
## Build Commands
36+
37+
1. Start development server:
38+
```bash
39+
npm run dev
40+
```
41+
2. Build for production:
42+
```bash
43+
npm run build
44+
```
45+
3. Preview production build:
46+
```bash
47+
npm run preview
48+
```
49+
50+
51+
52+
53+
54+
## Usage
55+
56+
- Open index.html to view the homepage
57+
58+
- Navigate to Blog, Catalog, About, and Contact pages via the menu
59+
60+
- Styles are written in src/styles/style.scss and compiled automatically
61+
62+
63+
## Screenshots
64+
Homepage banner:
65+
![Homepage Banner](screenshots/homepage.png)
66+
67+
68+
Catalog section:
69+
![Catalog Screenshot](screenshots/catalog.png)
70+
71+
72+
Blog section:
73+
![Blog Screenshot](screenshots/blog.png)
74+
75+
76+
77+
## Technologies Used
78+
79+
- HTML5 & SCSS
80+
81+
- Twig templating system
82+
83+
- Node.js & npm
84+
85+
- Vite for development and build
86+
87+
- PostCSS for CSS features
88+
89+
90+
## Project Structure
91+
- src/assets/icons → SVG icons for your project
92+
- src/assets/images → Images for your project
93+
- src/styles → SCSS stylesheets
94+
- src/data → JSON data
95+
- src/templates/layouts → Twig layouts
96+
- src/templates/partials → Twig partials
97+

screenshots/blog.png

166 KB
Loading

screenshots/catalog.png

102 KB
Loading

screenshots/homepage.png

85.8 KB
Loading

0 commit comments

Comments
 (0)