mathcale/silex-base-project

A simple Silex base project with routing, twig templates, database connection and some other cool stuff

1.2.3 2017-04-12 15:01 UTC

Requires

• php: >=5.5.9
• doctrine/dbal: ~2.2
• silex/silex: ^2.0
• symfony/asset: ^3.2
• symfony/console: ^3.2
• symfony/security: ^3.2
• symfony/twig-bridge: ^3.2
• twig/twig: ^1.31
• vlucas/phpdotenv: ^2.4

MIT

• Matheus Calegaro

• silex
• bootstrap
• base

README

A simple Silex 2.x base project with authentication, routing, twig templates, env. variables and some other cool stuff.

Requirements

• PHP >= 5.5.9
• Composer
• Apache Web Server

NOTE: If you're using another webserver, take a look at the official documentation on how to properly set it up.

Running the app

1. Clone the repo or get it from Packagist by running composer create-project --prefer-dist mathcale/silex-base-project on your websever root (e.g. /var/www/html ou C:/wamp/www)
2. cd silex-base-project
3. Edit the .env file with necessary info (database credentials, debug mode...)
4. Start your web server and go to the project's url (e.g. http://localhost/silex-base-project)
5. Have fun using Silex!

Creating the database

Now you can create a database schema by running the make:db command. To accomplish that, cd to the project's root and run php bin/console make:db --name DB_NAME, where DB_NAME == the name you want for your database.

If you already have a database, don't forget to change the SQL queries at src/Controllers/AuthController.php to match your schema.

ProTips(tm)

• If you want to use npm packages, make sure to update your .gitignore with the node_modules folder
• If you have cloned the repo, run composer install to download the project dependencies and then create the .env file by running php -r "file_exists('.env') || copy('.env.example', '.env');"
• If you used bin/console to create your database, the default login credentials are 'admin' and '123456' (encrypted using $app['security.encoder.digest']->encodePassword())

Contributing

Open Source projects are made for the community and by the community. It would be nice to have more people interacting and helping to improve this codebase. So, feel free to open (actual) issues and send pull requests if you fixed/implemented something.

License

MIT License

Copyright (c) 2017 Matheus Calegaro

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.