docs(README): 增加说明文件

This commit is contained in:
李东云
2023-01-13 18:14:13 +08:00
parent 1e4fbe5927
commit 4cf16ae0cd

View File

@@ -19,13 +19,10 @@ For instructions on how to install Composer visit [getcomposer.org](https://getc
After cloning this repository, change into the newly created directory and run
```bash
composer install
```
or if you have installed Composer locally in your current directory
```bash
php composer.phar install
composer config secure-http false \
&& composer config repo.lux-map composer https://satis.luxcreo.cn/ \
&& composer require singularity/hdk-core \
&& php bin/hyperf vendor:publish singularity/hdk-core
```
This will install all dependencies needed for the project.
@@ -35,32 +32,17 @@ This will install all dependencies needed for the project.
All tests can be run by executing
```bash
vendor/bin/phpunit
composer test
```
`phpunit` will automatically find all tests inside the `test` directory and run them based on the configuration in the `phpunit.xml` file.
### Testing Approach
The test for the class `Greeting` verifies that the return value of the `sayHello` method returns the string "Hello {name}", where {name} is the value passed through to the constructor.
## Running the Application
PHP has an in-built server for local development. This can be started by executing
```
php -S localhost:8000 -t public
```
Then open your browser at `http://localhost:8000/example.php`
You should see the text "Hello Ada Lovelace" on your screen.
`Pest` will automatically find all tests inside the `tests` directory and run them based on the configuration in the `phpunit.xml` file.
## Built With
- [PHP](https://secure.php.net/)
- [Composer](https://getcomposer.org/)
- [PHPUnit](https://phpunit.de/)
- [Hyperf](https://hyperf.wiki/2.2/)
- [Pest](https://pestphp.com/)
## License