Skip to content

docs(readme): add GitHub Actions CI badge #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CemWebDev merged 1 commit into from
Jun 12, 2025
Merged

docs(readme): add GitHub Actions CI badge #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 22 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@

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

![CI](https://github.com/CemWebDev/professional-multipage-business-website/actions/workflows/ci.yml/badge.svg)

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.

---

## ✨ Key Features

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


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

---

## 🔧 Tech Stack

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

---

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

### Available Scripts

| Command | Purpose |
| ------------------ | -------------------------------------- |
| `dev` | Start Vite dev server with HMR |
| `build` | Generate a production build in `dist/` |
| `preview` | Preview the production build locally |
| `format` | Run Prettier for code formatting |
| Command | Purpose |
| --------- | -------------------------------------- |
| `dev` | Start Vite dev server with HMR |
| `build` | Generate a production build in `dist/` |
| `preview` | Preview the production build locally |
| `format` | Run Prettier for code formatting |

---

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



---

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

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

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

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

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

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

---



## 📣 Acknowledgements

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

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