Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 75 lines (40 sloc) 2.27 kb
56cef03 @willdurand Introducing Propel2
willdurand authored
1 # Propel2 #
2030848 Added exported CVS repository.
hans authored
2
f6e8ebe @willdurand Added README
willdurand authored
3 Propel2 is an open-source Object-Relational Mapping (ORM) for PHP 5.3.
4
33f097d @willdurand Added travis-ci image
willdurand authored
5 [![Build Status](https://secure.travis-ci.org/propelorm/Propel2.png?branch=master)](http://travis-ci.org/willdurand/Propel2)
6
f6e8ebe @willdurand Added README
willdurand authored
7
8 ## Requirements ##
9
10 Propel2 uses the following Symfony2 Components:
11
1acccd7 @willdurand Start to use **Composer**
willdurand authored
12 * [Console](https://github.com/symfony/Console)
f6e8ebe @willdurand Added README
willdurand authored
13 * [Yaml](https://github.com/symfony/Yaml)
14
8136411 @willdurand Use Composer autoloader
willdurand authored
15 Propel2 also relies on [**Composer**](https://github.com/composer/composer) to manage dependencies but you
16 also can use [ClassLoader](https://github.com/symfony/ClassLoader) (see the `autoload.php.dist` file for instance).
17
06c2ee2 @willdurand Fixed PHP minimum version number (see: issue #71 for more information)
willdurand authored
18 Propel2 is only supported on PHP 5.3.3 and up.
f6e8ebe @willdurand Added README
willdurand authored
19
20
56cef03 @willdurand Introducing Propel2
willdurand authored
21 ## Installation ##
22
fffbb4a @willdurand Updated README
willdurand authored
23 Read the [Propel documentation](http://www.propelorm.org/).
56cef03 @willdurand Introducing Propel2
willdurand authored
24
25
fffbb4a @willdurand Updated README
willdurand authored
26 ## Contribute ##
27
28 Everybody can contribute to Propel2. Just fork it, and send Pull Requests.
1acccd7 @willdurand Start to use **Composer**
willdurand authored
29 You have to follow [Propel2 Coding Standards](https://github.com/propelorm/Propel2/wiki/Coding-Standards) and provides unit tests as much as possible.
fffbb4a @willdurand Updated README
willdurand authored
30
31 **Note:** you can fix checkstyle before to submit a Pull Request by using the Symfony2 `check_cs` script.
32 You just need to install [Finder](http://github.com/symfony/Finder) and the script:
33
34 git clone git://github.com/symfony/Finder.git vendor/Symfony/Component/Finder
35
36 wget https://raw.github.com/symfony/symfony/master/check_cs
37
38 Then use it:
39
40 php check_cs fix
41
42
43 ## Unit Tests ##
56cef03 @willdurand Introducing Propel2
willdurand authored
44
1acccd7 @willdurand Start to use **Composer**
willdurand authored
45 To run unit tests, you'll have to install vendors by using [**Composer**](https://github.com/composer/composer).
46 If you don't have an available `composer.phar` command, just download it:
56cef03 @willdurand Introducing Propel2
willdurand authored
47
1acccd7 @willdurand Start to use **Composer**
willdurand authored
48 wget http://getcomposer.org/composer.phar
49
50 Then, install dependencies:
51
52 php composer.phar install
56cef03 @willdurand Introducing Propel2
willdurand authored
53
19de9ee @willdurand Updated README
willdurand authored
54 The Propel test suite requires a database (`test` for instance, but feel free to choose the name you want), and
55 three database schemas: `bookstore_schemas`, `contest`, and `second_hand_books`.
318d4b1 @cedriclombardot Update readme to help running tests
cedriclombardot authored
56
19de9ee @willdurand Updated README
willdurand authored
57 Here is the set of commands to run in order to setup MySQL:
318d4b1 @cedriclombardot Update readme to help running tests
cedriclombardot authored
58
19de9ee @willdurand Updated README
willdurand authored
59 mysql -uroot -e 'create database test'
60 mysql -uroot -e 'create schema bookstore_schemas'
61 mysql -uroot -e 'create schema contest'
62 mysql -uroot -e 'create schema second_hand_books'
318d4b1 @cedriclombardot Update readme to help running tests
cedriclombardot authored
63
56cef03 @willdurand Introducing Propel2
willdurand authored
64 Once done, build fixtures:
65
c3b023f @willdurand Refactored how to prepare unit tests
willdurand authored
66 php bin/propel test:prepare
56cef03 @willdurand Introducing Propel2
willdurand authored
67
7b7ddf6 @willdurand Update README.md
willdurand authored
68 Now you can run the test suite by running:
56cef03 @willdurand Introducing Propel2
willdurand authored
69
fffbb4a @willdurand Updated README
willdurand authored
70 phpunit
f6e8ebe @willdurand Added README
willdurand authored
71
72 ## License ##
73
318d4b1 @cedriclombardot Update readme to help running tests
cedriclombardot authored
74 See the `LICENSE` file.
Something went wrong with that request. Please try again.