Skip to content

Commit 9cf3807

Browse files
committed
Added alternative way of installation
1 parent 89ba80e commit 9cf3807

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44

55
This is a simple secure implementation of family tree, developed as the final project of **Data Structures and Algorithms** (**Fall 2023**) course at **Iran University of Science and Technology**. The architecture of the project is based on the [project description](schema/description.pdf) provided by teaching assistants.
66

7-
## Dependencies
7+
## Installation
8+
9+
### Recommended Way: Manual Installation
10+
11+
#### Dependencies
812

913
On Ubuntu operating system, install these dependencies:
1014

@@ -16,7 +20,7 @@ wget https://github.com/CrowCpp/Crow/releases/download/v1.0%2B5/crow-v1.0+5.deb
1620
sudo apt-get install crow-v1.0+5.deb
1721
```
1822

19-
## Compilation
23+
#### Compilation
2024

2125
On Unix-like operating systems, to compile the project and run the web application, just run `run.sh` with `app` argument:
2226

@@ -39,7 +43,9 @@ g++ -o app.out app.cpp *.o -ljsoncpp
3943
./app.out
4044
```
4145

42-
Then you can run `main` to use the interface.
46+
### Alternative Way: Docker Image
47+
48+
You can use [`Dockerfile`](./Dockerfile) in order to build an image containing everything neccesary to run the web application. But since it is not fully tested yet, we do not recommend this way.
4349

4450
## Schema
4551

0 commit comments

Comments
 (0)