From ca674e7e7e26da04ef9e2f5c13ab27671cfb5544 Mon Sep 17 00:00:00 2001 From: Cem Date: Thu, 12 Jun 2025 18:04:36 +0300 Subject: [PATCH] docs(readme): add GitHub Actions CI badge --- README.md | 49 ++++++++++++++++++++++--------------------------- 1 file changed, 22 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index cce5995..5a98cff 100644 --- a/README.md +++ b/README.md @@ -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) --- @@ -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 | --- @@ -71,8 +71,6 @@ $ npm run dev # http://localhost:5173 └── vite.config.js # Vite configuration ``` - - --- ## 🌐 Deployment @@ -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! @@ -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/) @@ -112,4 +108,3 @@ Please follow the existing code style and add relevant tests where applicable. --- Made with by [@CemWebDev](https://github.com/CemWebDev) -