Skip to content

Commit 0bf1962

Browse files
committed
📝 add readme
1 parent 7cdab08 commit 0bf1962

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Symfony React Blank
2+
Symfony React Blank is a blank symfony and react project, use this template to start your app using Symfony as an backend api and React as a frontend library.
3+
4+
## Installation
5+
* [Install Composer](https://getcomposer.org/download).
6+
* [Install Yarn](https://yarnpkg.com/) or [NodeJS](https://nodejs.org/).
7+
* Click on "use this template" button on the top of this repository and run the following commands:
8+
9+
```
10+
# Clone the project to download its contents
11+
> cd projects/
12+
> git clone <your repository link>.git
13+
or
14+
> git clone https://github.com/AntoineKM/symfony-react-blank.git
15+
16+
# Make Composer install the project's dependencies into vendor/
17+
# Warning: This template requires php >=8.0.0
18+
> cd <your project name>
19+
or
20+
> cd symfony-react-blank
21+
> composer install
22+
23+
# Make Yarn install the project's dependencies into node_modules/
24+
> yarn install
25+
26+
```
27+
28+
* Finally, setup your ``.env.local`` as the [.env](.env)
29+
30+
## Usage
31+
```
32+
# Startup the Symfony server
33+
> symfony server:start
34+
35+
# Then startup the Symfony Encore server
36+
> yarn dev-server
37+
```
38+
39+
* Access the server at http://localhost:8000

0 commit comments

Comments
 (0)