Skip to content

Commit 9b3e402

Browse files
authored
Merge pull request #209 from lypitech/dev
refactor(readme): Added installation steps. Force reason: Time limit.
2 parents b3990d0 + 2cb46f6 commit 9b3e402

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,25 @@ The application will offer the following functionalities:
5555
<a name="installation"></a>
5656
## Installation
5757

58-
...
58+
1. Clone the project
59+
```sh
60+
git clone git:github.com@lypitech/area.git area
61+
```
62+
63+
2. Go in the cloned project
64+
```sh
65+
cd area/
66+
```
67+
68+
3. Run the project
69+
```sh
70+
docker-compose up --build
71+
```
72+
73+
> [!CAUTION]
74+
> You must have [Docker](https://www.docker.com/) installed on your machine.
75+
76+
Now the API is exposed on port `8080`, website is exposed on port `8081` and APK installation file can be found at route `/client.apk`.
5977

6078
<a name="team"></a>
6179
## Team

0 commit comments

Comments
 (0)