📊 Repository Badges

---

📌 Quick Access

• README.md
• LICENSE
• config/.gitignore
• config/.prettierrc.json
• config/.prettierignore
• config/.gitattributes
• config/.editorconfig
• src/

---

📋 Table of Contents

1. Description
2. Demo
3. Goals
4. Technologies
5. Prerequisites
6. Installation & Usage
7. Project Structure
8. Useful Scripts
9. Features
10. Environment Variables
11. Known Issues
12. Roadmap
13. Project Status
14. Contributing
15. License
16. Contact
17. Credits
18. Changelog

---

Description

Project Name is a minimal boilerplate for static websites using HTML + CSS, with Prettier for code formatting.

---

Demo

Screenshot or live example of the app:

🔗 Live Demo Not yet available

---

Goals

• Provide a professional starter template.
• Maintain code quality via Prettier.
• Document the project with a clean README.

---

Technologies

• HTML5
• CSS3
• Prettier

---

Prerequisites

• Git
• VSCode with extensions:
  • Prettier
  • Live Server

---

Installation & Usage

# Clone the repository

git clone https://github.com/<user>/<repo>.git
cd <repo>

📝 Notes

• Open src/index.html in your browser or run with Live Server in VSCode.

---

Project Structure

basekit/                                # Root directory of the BaseKit template
├─ .github/                             # GitHub-specific configuration and templates
│  └─ ISSUE_TEMPLATE/                   # Directory containing issue templates
│     └─ bug_report.md                  # Template for reporting reproducible bugs
│     └─ feature_request.md             # Template for suggesting new features
│  └─ CODEOWNERS                        # Defines repository code owners who must review PRs
│  └─ FUNDING.yml                       # Configures sponsor links (GitHub Sponsors, BuyMeACoffee, etc.)
│  └─ PULL_REQUEST_TEMPLATE.md          # Template for standardizing Pull Requests
├─ .vscode/                             # Visual Studio Code project configuration
│  └─ settings.json                     # VSCode preferences (formatting, extensions, editor rules)
├─ img/                                 # Folder for image assets
├─ src/                                 # Project source code
│  ├─ index.html                        # Main HTML file (entry point)
│  ├─ styles.css                        # Base CSS stylesheet
├─ .editorconfig                        # Enforces consistent coding styles across editors/IDEs
├─ .gitignore                           # Defines files/folders Git should ignore
├─ .gitattributes                       # Normalizes line endings and defines binary files
├─ .prettierrc.json                     # Prettier configuration file (formatting rules)
├─ .prettierignore                      # Files/folders excluded from Prettier formatting
├─ CHANGELOG.md                         # Version history and notable project changes
├─ CODE_OF_CONDUCT.md                   # Contributor behavior rules (Contributor Covenant)
├─ CONTRIBUTING.md                      # Contribution guidelines (workflow, branches, PR rules)
├─ LICENSE                              # License for project usage (MIT or other)
├─ README.md                            # Main documentation: description, usage, structure
├─ SECURITY.md                          # Security policy and vulnerability reporting process
└─ SUPPORT.md                           # How to get help (issues, scope, response times)

---

Useful Scripts

npm init -y
npm install -D prettier
npx prettier --write .

---

Features

• ✅ Minimal, no dependencies
• ✅ Prettier formatting included
• ✅ Clear modular structure (src/, img/, .vscode/)
• 🚧 Pending: UI framework integration (React/Tailwind)

---

Roadmap

• Add JavaScript support (optional)
• Add deployment with GitHub Pages
• Extend styles with a CSS framework

---

Project Status

Contributing

1. Fork the repository
2. Create a new branch (git checkout -b feature/your-feature)
3. Commit your changes (git commit -m 'feat: add feature')
4. Push the branch (git push origin feature/your-feature)
5. Open a Pull Request

⚠️ Guidelines: Conventional Commits + small, well-documented PRs.

---

License

This project is licensed under the MIT License.
See LICENSE for details.

---

Contact

• GitHub: ferran-cipres
• LinkedIn: Ferran Ciprés
• Email: [email protected]

---

Credits

• FreeCodeCamp Guide
• Adapted by Ferran Ciprés

---

Changelog

All notable changes to this project will be documented here. [1.0.0] - 2025-09-20

• Initial release of html-css-template
• Base project structure (src/, img/, .vscode/, config/)
• Prettier configuration (.prettierrc.json, .prettierignore)
• Git settings (.gitignore, .gitattributes)
• Editor settings (.editorconfig)
• Documentation (README.md)
• License (MIT)
• GitHub templates for Issues and Pull Requests