Skip to content
This repository has been archived by the owner on Feb 21, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
butschster authored Dec 21, 2022
1 parent b56fa14 commit a626fb0
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,43 @@
# Spiral Application installer

[App Skeleton](https://github.com/spiral/app) | [**Documentation**](https://spiral.dev/docs) | [Discord](https://discord.gg/TFeEmCs) | [Twitter](https://twitter.com/spiralphp) | [Contributing](https://spiral.dev/docs/about-contributing/)

![Installer](https://user-images.githubusercontent.com/773481/208850084-891a9d6f-3e70-4a06-af57-4e63c37c9c47.png)

Spiral Framework is a High-Performance PHP/Go Full-Stack framework and group of over sixty PSR-compatible components. The Framework execution model based on a hybrid runtime where some services (GRPC, Queue, WebSockets, etc.) handled by Application Server [RoadRunner](https://github.com/roadrunner-server/roadrunner) and the PHP code of your application stays in memory permanently (anti-memory leak tools included).

[App Skeleton](https://github.com/spiral/app) | [**Documentation**](https://spiral.dev/docs) | [Discord](https://discord.gg/TFeEmCs) | [Twitter](https://twitter.com/spiralphp) | [CHANGELOG](/CHANGELOG.md) | [Contributing](https://spiral.dev/docs/about-contributing/)
<br />

## Server Requirements

Make sure that your server is configured with following PHP version and extensions:
* PHP 8.1+, 64bit
* *mb-string* extension
* [mb-string](https://www.php.net/manual/en/intro.mbstring.php) extension
* PDO Extension with desired database drivers


## Installation

```bash
composer create-project spiral/installer
composer create-project spiral/installer my-app
```

> Application server will be downloaded automatically (`php-curl` and `php-zip` required).
> **Note**: Application server will be downloaded automatically (`php-curl` and `php-zip` required).
<br />

To start application server execute:
After the project has been created and installed, start RoadRunner server using the following command:

```bash
cd my-app

./rr serve
```

Application will be available on `http://localhost:8080`.
<br />

Once you have started RoadRunner server, your application will be accessible in your web browser at `http://localhost:8080`.

> Read more about application server configuration [here](https://roadrunner.dev/docs).
> **Note**: Read more about application server configuration [here](https://roadrunner.dev/docs).
## License:

Expand Down

0 comments on commit a626fb0

Please sign in to comment.