Giter Club home page Giter Club logo

app's Introduction

[Chiron Framework] is a light framework designed to allow developpers to quickly start a new console or web application.

Chiron Framework

This repository contain an App Skeletton intended to show the basic Chiron features. Your first step to build amazing projects !

Latest Stable Version Total Downloads Build Status

Requirements

Make sure that your web server is configured with following PHP version and extensions:

  • PHP >= 7.2
  • intl PHP Extension
  • mbstring PHP Extension

Installation

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

You can then install this project template using the following command:

$ composer create-project chiron/app [my-app-name]

Replace [my-app-name] with the desired directory name for your new application.

Cloning

This section applies only if you cloned this repo with git clone, not when installed with composer create-project ....

Make sure to properly configure your app project after cloning this repository.

$ composer install                      # Install the projet composer dependencies

$ bin/chiron dotenv:copy -d .env        # Create the .env file at the root path
$ bin/chiron dotenv:key -m .env         # Update the security key in .env file
$ bin/chiron package:discover           # Auto-discover the module bootloaders

Web Server

You can launch a development web server to quickly test you application.

$ php -S localhost:8000 -t public/

or

$ bin/chiron serve

Now you should be able to access the application through the URL printed in the console.

Directory structure

The application template has the following structure:

config/                   #Configuration files.
docs/                     #Documentation.
public/                   #Files publically accessible from the Internet.
    assets/               #Published assets.
    index.php             #Entry script.
resources/                #Application resources.
    assets/               #Asset bundle resources.
    layout/               #Layout view templates.
    view/                 #View templates.
runtime/                  #Files generated during runtime.
src/                      #Application source code.
    Asset/                #Asset bundle definitions.
    Controller/           #Web controller classes.
    Provider/             #Providers that take configuration and configure services.
tests/                    #A set of Codeception tests for the application.
vendor/                   #Installed Composer packages.

Testing

To test an application:

$ ./vendor/bin/phpunit

or

$ composer phpunit

License

This package is open-sourced software licensed under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.