Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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