Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Codeception/phalcon-demo
https://github.com/Codeception/phalcon-demo
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Codeception/phalcon-demo
- Owner: Codeception
- License: other
- Created: 2015-10-22T17:02:29.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-03-11T23:22:56.000Z (over 2 years ago)
- Last Synced: 2024-04-14T02:40:03.872Z (7 months ago)
- Language: PHP
- Size: 119 KB
- Stars: 43
- Watchers: 18
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-phalcon - phalcon-demo - A modified Phalcon INVO Application to demonstrate basics of Codeception testing. (Testing)
README
# Phalcon Demo Application
[][phalcon-demo]
We use **modified** [Phalcon INVO Application][1] to demonstrate basics of Codeception testing.
We expect to implement as many features as possible to showcase the framework and its
potential.
Please write us if you have any feedback.
Thanks.
## NOTE
The master branch will always contain the latest stable version. If you wish
to check older versions or newer ones currently under development, please
switch to the relevant branch.
## Get Started
### Requirements
* PHP >= 7.2
* Latest stable [Phalcon Framework v4][4] extension enabled
* [MySQL][5] >= 5.1.5
* Codeception >= 4.0
### Installation
#### The Composer way (recommended)
Using Composer, you can create a new project, write this code on your terminal:
```sh
composer create-project codeception/phalcon-demo --prefer-dist
```
After running this command, there should be an output, similar below:
```
Installing codeception/phalcon-demo (version)
- Installing codeception/phalcon-demo (version)
Created project in
Loading composer repositories with package information
Updating dependencies (including require-dev)
...
...
...
Writing lock file
Generating autoload files
Do you want to remove the existing VCS (.git, .svn..) history? [Y,n]? y
```
#### The Git way
Another way to fetch project by using `git clone`:
First you need to clone this repository:
```sh
git clone [email protected]:Codeception/phalcon-demo.git
```
Install composer in a common location or in your project:
```sh
curl -s http://getcomposer.org/installer | php
```
Then install dependencies:
```sh
php composer.phar install
```
#### Setup Database
A MySQL database is also bundled in this project. The connection to the database is required for several tests.
You'll need to create the database and initialize schema.
You can create a database as follows:
```sh
echo 'CREATE DATABASE phalcon_demo CHARSET=utf8 COLLATE=utf8_unicode_ci' | mysql -u root
```
then initialize schema:
```
cat schemas/phalcon_demo.sql | mysql -u root phalcon_demo
```
**Note:**
For these tests we use the user `root` with `password` as password. You may need to change this in `tests/codeception.yml`.
You can override application config by creating `app/config/config.ini.dev` (already gitignored).
## Tests
Phalcon Demo Application uses [Codeception][6] functional, acceptance and unit tests.
First you need to re-generate base classes for all suites:
```sh
vendor/bin/codecept build
```
You can execute all test with `run` command:
```sh
vendor/bin/codecept run
# OR detailed output
vendor/bin/codecept run --debug
```
Read more about the installation and configuration of Codeception:
* [Codeception Introduction][7]
* [Codeception Console Commands][8]
If you cannot run the tests, please refer to the `.travis.yml` file for more instructions how we test Phalcon Demo Application.
For detailed information on our application environment setting refer to `app/config/env.php` file.
### Functional Tests
Demonstrates testing of CRUD application with:
* [UserSteps][9]
## Contributing
See [CONTRIBUTING.md][15]
## License
Phalcon Demo Application is open-sourced software licensed under the [New BSD License][16].
© 2012 - 2020 Phalcon Framework Team and contributors
© 2015 - 2020 Codeception Team and contributors
[phalcon-demo]: https://travis-ci.org/Codeception/phalcon-demo
[1]: https://github.com/phalcon/invo/
[2]: https://nginx.org/
[3]: https://php.net/manual/en/install.fpm.php
[4]: https://github.com/phalcon/cphalcon/releases
[5]: https://www.mysql.com/
[6]: https://codeception.com/
[7]: https://codeception.com/docs/01-Introduction
[8]: https://codeception.com/docs/reference/Commands
[9]: https://github.com/Codeception/phalcon-demo/blob/master/tests/_support/User/Functional/UserSteps.php
[15]: https://github.com/Codeception/phalcon-demo/blob/master/CONTRIBUTING.md
[16]: https://github.com/Codeception/phalcon-demo/blob/master/LICENSE.txt