Civic Framework Documentation
Install. Configure. Build with Confidence.
Everything you need to set up and customize your template.
Installation Guide
Follow the steps below to install and set up the Civic Framework template. This guide applies to both the HTML version and the PHP version.
1. Unzip the Download Package
After downloading civic-framework.zip, extract the contents to your computer. Inside, you will find:
- HTML Version – Static HTML files
- PHP Version – Dynamic PHP files with reusable components
- Documentation – This documentation folder
- Assets – Images, CSS, JS, and media files
File Structure Overview
Below is the default folder structure included in the Civic Framework package:
civic-framework/
│
├── index.html
├── contact.php
├── contact-form.php
├── favicon.png
├── privacy-cookies-policy.html
├── 404.html
│
├── css/
│ ├── style.css
│ └── components.css
│
├── js/
│ ├── main.js
│ └── cookie-consent.js
│
├── images/
│ ├── logo/
│ ├── icons/
│ └── media/
│
├── Video/
│ └── civic-framework.mp4
│
├── pages/
│ └── (inner pages)
│
├── news/
├── events/
├── donation/
├── services/
├── home/
│
├── partials/
│ ├── header.php
│ └── footer.php
│
├── phpmailer/
│ └── (email library)
│
└── documentation/
├── index.html
├── documentation.css
├── readme.txt
└── license.txt
This structure ensures clean organization for both HTML and PHP versions, making customization and deployment straightforward.
2. Upload Files to Your Server
Use FTP, cPanel File Manager, or your hosting control panel to upload the template files to your server.
- Upload the HTML version to your public directory (usually
public_html/). - Upload the PHP version if you want dynamic includes and cleaner structure.
- Ensure all folders such as
css/,js/,images/, andVideo/are uploaded.
3. Verify File Paths
Make sure all paths are correct, especially if you move files into subfolders. For example, inside the documentation folder, all assets must use:
../css/style.css
../js/script.js
../images/...
This ensures the documentation loads correctly.
4. PHP Version Setup (Optional)
If you are using the PHP version:
- Ensure your hosting supports PHP 7.4+
- Includes such as
header.phpandfooter.phpmust use correct relative paths - Contact forms require PHPMailer (included in the package)
5. Contact Form Setup
To activate the contact form, open:
contact-form.php
Update the following line with your email address:
$recipient = "your-email@example.com";
Save and upload the file back to your server.
6. Testing Your Installation
Once uploaded, visit your domain in a browser:
https://yourdomain.com/
Check that:
- All pages load correctly
- Images, CSS, and JS are working
- Navigation links function properly
- Contact form sends emails successfully
You're All Set!
Your Civic Framework template is now installed and ready to customize. Continue exploring the documentation for more features and configuration options.