README

Icarus was built with the intention of producing a lightweight, user-friendly framework to aid in the building of websites. The idea is that when starting a fresh client project, we can simply install the tested code for the essential functionalities and then build on that.

Getting Started

Composer require

to get started using icarus you can require it from composer.
you can install it along with your other composer packages

composer require kingston/icarus

Base Application

The base application is our own template for getting started building icarus applications. to get started just clone the repository from here and then run composer install

composer install

-then open the env.example file, enter your database credentials and then save it as env.

Next just cd into your scripts directory and run the database migrations.

cd scripts
php migrations.php

Next move into your public folder and start your php server.

cd public
php -S localhost:5050

then just open your localhost in your browser and you should see something like this and you will be good to go.

Contributing

Any form of contributions are fully accepted, just Future versions of this framework are planned, with massive extensions to the logic side of things. we welcome any and all contributions, so please feel free to contribute. If you have ideas for the direction that the framework should take, please don't hesitate to open a github issue here or just directy get in touch with the creatr here.

Licence

This code is relased under the MIT License. Please see the LICENSE file for more information on what this means and how to make attributions.

Documentation

For more details read the docs here

kingston / icarus

Maintainers

Details