Skip to content

Commit 3309657

Browse files
authored
Merge pull request #3 from CemWebDev/feat/tests
docs(readme): add GitHub Actions CI badge
2 parents 5570b2c + ca674e7 commit 3309657

1 file changed

Lines changed: 22 additions & 27 deletions

File tree

README.md

Lines changed: 22 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22

33
[Live Demo →](https://professional-multipage-business-website.vercel.app/)
44

5+
![CI](https://github.com/CemWebDev/professional-multipage-business-website/actions/workflows/ci.yml/badge.svg)
6+
57
A modern, fully‑responsive **multi‑page** website built with **React 18**, **Vite 5**, and **Tailwind CSS 3**. Ideal for showcasing a corporate‑style landing + content site in your portfolio.
68

79
---
810

911
## ✨ Key Features
1012

11-
| Category | Details |
12-
| --------------------------- | ------------------------------------------------------------------------------------------------------------------- |
13-
| **Multi‑page Routing** | Seamless navigation between *Home*, *Sign In*, *Sign Up* and *Forgot Password* pages via `react‑router‑dom@6`. |
14-
| **Responsive Design** | Mobile‑first Tailwind utility classes with fluid typography. |
15-
| **Reusable UI Components** | Atomic `Button`, `Card`, `SectionHeader`, and `CTA` components speed up new‑page creation. |
16-
| **Functional Contact Form** | Plug‑and‑play [Formspree](https://formspree.io/) integration (swap with your own endpoint in seconds). |
17-
| **Vercel Hosting** | Automatic previews & production deploys for every push (zero‑config Vercel pipeline). |
18-
19-
13+
| Category | Details |
14+
| --------------------------- | -------------------------------------------------------------------------------------------------------------- |
15+
| **Multi‑page Routing** | Seamless navigation between _Home_, _Sign In_, _Sign Up_ and _Forgot Password_ pages via `react‑router‑dom@6`. |
16+
| **Responsive Design** | Mobile‑first Tailwind utility classes with fluid typography. |
17+
| **Reusable UI Components** | Atomic `Button`, `Card`, `SectionHeader`, and `CTA` components speed up new‑page creation. |
18+
| **Functional Contact Form** | Plug‑and‑play [Formspree](https://formspree.io/) integration (swap with your own endpoint in seconds). |
19+
| **Vercel Hosting** | Automatic previews & production deploys for every push (zero‑config Vercel pipeline). |
2020

2121
---
2222

2323
## 🔧 Tech Stack
2424

25-
* **Frontend:** React 18, Vite 5, React Router DOM 6
26-
* **Styling:** Tailwind CSS 3, PostCSS, Autoprefixer
27-
* **Deployment:** Vercel (static SPA build)
25+
- **Frontend:** React 18, Vite 5, React Router DOM 6
26+
- **Styling:** Tailwind CSS 3, PostCSS, Autoprefixer
27+
- **Deployment:** Vercel (static SPA build)
2828

2929
---
3030

@@ -44,12 +44,12 @@ $ npm run dev # http://localhost:5173
4444

4545
### Available Scripts
4646

47-
| Command | Purpose |
48-
| ------------------ | -------------------------------------- |
49-
| `dev` | Start Vite dev server with HMR |
50-
| `build` | Generate a production build in `dist/` |
51-
| `preview` | Preview the production build locally |
52-
| `format` | Run Prettier for code formatting |
47+
| Command | Purpose |
48+
| --------- | -------------------------------------- |
49+
| `dev` | Start Vite dev server with HMR |
50+
| `build` | Generate a production build in `dist/` |
51+
| `preview` | Preview the production build locally |
52+
| `format` | Run Prettier for code formatting |
5353

5454
---
5555

@@ -71,8 +71,6 @@ $ npm run dev # http://localhost:5173
7171
└── vite.config.js # Vite configuration
7272
```
7373

74-
75-
7674
---
7775

7876
## 🌐 Deployment
@@ -81,7 +79,7 @@ Deploying to your own Vercel account takes seconds:
8179

8280
1. **Fork** the repo and push it to GitHub.
8381
2. Go to [Vercel](https://vercel.com)**New Project**.
84-
3. Select the repository and keep the *Vite → React* preset.
82+
3. Select the repository and keep the _Vite → React_ preset.
8583
4. Ensure the output directory is `dist` (default).
8684
5. Click **Deploy** – voilà, your own URL is live!
8785

@@ -91,17 +89,15 @@ Deploying to your own Vercel account takes seconds:
9189

9290
Contributions are more than welcome! Feel free to **open an issue** for bugs or feature requests, or **create a pull request** with your improvements.
9391

94-
1. Fork the project & create your branch: `git checkout -b feature/awesome`
95-
2. Commit your changes: `git commit -m "feat: add awesome feature"`
96-
3. Push to the branch: `git push origin feature/awesome`
92+
1. Fork the project & create your branch: `git checkout -b feature/awesome`
93+
2. Commit your changes: `git commit -m "feat: add awesome feature"`
94+
3. Push to the branch: `git push origin feature/awesome`
9795
4. Open a Pull Request.
9896

9997
Please follow the existing code style and add relevant tests where applicable.
10098

10199
---
102100

103-
104-
105101
## 📣 Acknowledgements
106102

107103
- [React](https://react.dev/)
@@ -112,4 +108,3 @@ Please follow the existing code style and add relevant tests where applicable.
112108
---
113109

114110
Made with by [@CemWebDev](https://github.com/CemWebDev)
115-

0 commit comments

Comments
 (0)