Here you can find a base project for your website on Apache server. This project offers the next advantages:
- Beautified URLs. No one likes complex and easy-to-forget links!
- Organized project. Each file is stored following a logic structure.
- Easy customizable layout. Pages are created using templates and configurations.
- From begginer no expert. The project is ready-to-go but you can change it to fit your needs.
But before you start there are some things you have to change!
Follow these steps to publish successfully this website on a web server.
- Download and extract this repo on the server's public directory (usually:
/public_html,/htmlor/www). - It's time to make some changes. Edit app's configuration and change
$pathvariable (read App configuration) to fit your environment. For example:-
If your webpage is hosted in
www.somepage.com, then$path="/". -
If your webpage is hosted in some subdirectory as
www.somepage.com/newProject, then$path="/newProject/".
-
- Edit
.htaccessfile and make the same change as in the previous step:RewriteBase "/" OR RewriteBase "/newProject" - Add your pages! To do so, you only have to create a new file at
views/folder (i.e.views/cv.php). It's important that the file contains.phpextension because the app's controller (controller.php) searches for this file extension only. Feel free to change it if you want to.
Once you make those changes you should be able to use the website whitout problems. Read further to know how to customize this base project. If you don't know how to do something try the Questions and Answers section or send an email to the creator.
You can find the app's configuration at /docs/php/config.php.
| Variable name | Details |
|---|---|
$app_name |
Stores the name of the website/application. It's used as default window title and navbar's home link. |
$path |
Stores the relative path needed to access the web/app inside the server. In most of the cases $path="/" is correct but it can change in other environments. |
$server_root |
Stores PHP's $_SERVER["CONTEXT_DOCUMENT_ROOT"] global variable in order to access it easily. It's not suposed to be changed. |
$server_path |
Stores the absolute path to the project's root directory. It's not suposed to be changed. |
$page_config |
Stores the default page configuration. Further reading at Page configuration |
This configuration files are used to customize webpages' design. Default page configuration is stored on the app's config but it can be overrided or completed at /views/configs dir.
If you want to override somepage.php's page configuration you only have to create a somepage.php file on that directory.
| Variable name | Accepted types | Default value | Details |
|---|---|---|---|
title |
String | $app_name |
Window title of the web/app. |
navbar |
Array, Boolean | Array(navbar_config) |
Information about the navbar. If you want to disable it write "navbar" => false. |
navbar.title |
String | $app_name |
Navbar's title. |
navbar.home |
String (URL) | $path |
Navbar's title's link. |
navbar.links |
Array | Some examples | Navbar's other links. Each link has an ID and it can be overrided using the same ID on custom configuration. Check links format here |
footer |
Boolean | true |
Decides wether footer is displayed or not. |
To add a new link to the navbar.links array you only have to add a new entry to it following the next format: "$id" => ["$tex","$linkg"]. For example: "1" => ["External Site","http://www.duckduckgo.com"] or "2" => ["About Us",$path . "about"].
| Question | Answer |
|---|---|
| How can I edit my base template? | The template is defined in controler.php file. You can adjust it to your needs there. |
| How can I import a new script/css file/image ? | Images, scripts and style files are stored inside the docs/ directory, but in your html code you have to write static/file_path/file_name.ext to access it. For example: docs/css/style.css file is accessed by writing static/css/style.css. |
| Can I publish this base project into another web server distict from Apache? | PHP is enabled by default in most of the web servers but .htaccess files are Apache's special files. This file is used in this project to beautify URLs and redirect static files so you can't publish this project into other web servers as-is, although you can adjust it in order to work in your server. But don't worry, Apache is one of the most used web servers in the world! |
| Is there any libraries imported in the base project? | Yes! Bootstrap v4.5, jQuery and Popper are imported on the project's template. You can delete them if you want to. |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent