Framework Boilerplate

by Jari van Kaam

this project is made to simplify and speed up the process of creating a new project. It is very loosely based on a framework I use in my internship. It is not meant to be used as a framework, but as a starting point for your own project.

Features

• preconfigured watch commands for sass(scss) based css coding and Typescript.
• php file router
• ordend file structure.
• laravel like naming conventions in folder names.

file structure

project
│   
│   
│
└─── private
|   |
|   └─── scss
|   |     |
|   |     └─── base
|   |     |
|   |     └─── template-parts
|   |     |
|   |     └─── style.scss
|   |
│   │   
│   │
│   └─── TS
│         └───  index.ts
│       
│   
└─── public
|    └─── views
|    │   │
|    |   └─── parts
|    |   |     └─── section-test.php
|    |   |     |
|    |   |     └─── section-1.php
|    |   |
|    |   |
|    |   └─── requires
|    |   |      └─── head.php
|    |   |      |
|    |   |      └─── header.php
|   
└─── .gitignore
└─── .htacces
└─── 404.php
└─── index.php - containes routers

Installation

• clone the repository
• run npm i or yarn install to install all dependencies
• to watch for changes in folder private/scss run npm run watch:css or yarn watch:css
• to watch for changes in folder private/ts run npm run watch:ts or yarn watch:ts
• to scan the project use npm run test or yarn test

This project is free to use, but please give credit where credit is due.