From ff89ea5bec9be164fb324b4e7df716a8d00987a4 Mon Sep 17 00:00:00 2001 From: Mark Story Date: Mon, 3 Aug 2015 17:57:48 -0400 Subject: [PATCH] Add README and dotfiles. --- .editorconfig | 18 ++++++++++++++++++ .gitattributes | 36 ++++++++++++++++++++++++++++++++++++ .gitignore | 4 ++++ .htaccess | 5 +++++ README.md | 14 ++++++++++++++ 5 files changed, 77 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 .htaccess create mode 100644 README.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7061901 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.bat] +end_of_line = crlf + +[*.yml] +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..926a808 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,36 @@ +# Define the line ending behavior of the different file extensions +# Set default behaviour, in case users don't have core.autocrlf set. +* text=auto +* text eol=lf + +# Explicitly declare text files we want to always be normalized and converted +# to native line endings on checkout. +*.php text +*.default text +*.ctp text +*.sql text +*.md text +*.po text +*.js text +*.css text +*.ini text +*.properties text +*.txt text +*.xml text +*.yml text +.htaccess text + +# Declare files that will always have CRLF line endings on checkout. +*.bat eol=crlf + +# Declare files that will always have LF line endings on checkout. +*.pem eol=lf + +# Denote all files that are truly binary and should not be modified. +*.png binary +*.jpg binary +*.gif binary +*.ico binary +*.mo binary +*.pdf binary +*.phar binary diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e2e825d --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/vendor/* +/config/app.php +/tmp/* +/logs/* diff --git a/.htaccess b/.htaccess new file mode 100644 index 0000000..fc3aac4 --- /dev/null +++ b/.htaccess @@ -0,0 +1,5 @@ + + RewriteEngine on + RewriteRule ^$ webroot/ [L] + RewriteRule (.*) webroot/$1 [L] + \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6e2dd0 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# CakePHP Bookmarker Sample Application + +This is a sample application that is the result of following +the [bookmarker tutorial](http://book.cakephp.org/3.0/en/quickstart.html). + +# Installation & Setup + +1. Download [Composer](http://getcomposer.org/doc/00-intro.md) or update `composer self-update`. +2. Download this repository - `git clone git://github.com/cakephp/bookmarker-sample-app` +3. Install dependencies with composer - `composer install`. +4. Add the schema to a new database. +5. Configure your database credentials in ``app.php``. Make sure to set the database name from step 4. +6. Start the server `bin/cake server -p 8765`. +7. Go to http://localhost:8765 in your browser.