|
@@ -1,5 +1,5 @@
|
|
# SIN3D
|
|
# SIN3D
|
|
-> Synthesis Image Noise Detection on Distributed Data
|
|
|
|
|
|
+> Synthesis Image Noise Detection on Distributed Data (SIN3D)
|
|
|
|
|
|
A web app to collect data on noise detection by humans on images.
|
|
A web app to collect data on noise detection by humans on images.
|
|
|
|
|
|
@@ -9,6 +9,12 @@ git clone https://gogs.univ-littoral.fr/Prise3D/SIN3D.git
|
|
cd SIN3D
|
|
cd SIN3D
|
|
```
|
|
```
|
|
|
|
|
|
|
|
+## Developer documentation
|
|
|
|
+See [`/DOCUMENTATION`](./DOCUMENTATION).
|
|
|
|
+
|
|
|
|
+## Data extraction
|
|
|
|
+You can use the [SIN3D-data-extract](https://gogs.univ-littoral.fr/Prise3D/SIN3D-data-extract) library to easily extract data from this application database.
|
|
|
|
+
|
|
## Run as a Docker instance
|
|
## Run as a Docker instance
|
|
### Configure application
|
|
### Configure application
|
|
Use the following environment variables to configure the application.
|
|
Use the following environment variables to configure the application.
|
|
@@ -37,16 +43,6 @@ Configure more deeply the way the app works by modifying *[config.js](config.js)
|
|
| `logger` | Logs : `logs/server.combined.log` Errors : `logs/server.error.log` | Default application logger |
|
|
| `logger` | Logs : `logs/server.combined.log` Errors : `logs/server.error.log` | Default application logger |
|
|
| `dbLogger` | Logs : `logs/db.log` Errors : `logs/db.error.log` | Database logger configuration |
|
|
| `dbLogger` | Logs : `logs/db.log` Errors : `logs/db.error.log` | Database logger configuration |
|
|
|
|
|
|
-### Configure experiments
|
|
|
|
-If you want to use the default experiments configurations, you can skip this part, the Dockerfile does it for you.
|
|
|
|
-
|
|
|
|
-You can modify the configuration for each mixins, experiments or scene. To do so, you first need to initialize experiment configurations first.
|
|
|
|
-```sh
|
|
|
|
-cp -r experimentConfig.default experimentConfig
|
|
|
|
-```
|
|
|
|
-You can modify the configuration for each mixins, experiments or scene by modifying files in the newly created *`./experimentConfig`* directory.
|
|
|
|
-You configuration will be copied in the Docker instance.
|
|
|
|
-
|
|
|
|
### Run server + client
|
|
### Run server + client
|
|
Linux
|
|
Linux
|
|
```sh
|
|
```sh
|
|
@@ -167,7 +163,7 @@ The `docker-compose` script will automatically run tests. Use the following comm
|
|
yarn test
|
|
yarn test
|
|
```
|
|
```
|
|
|
|
|
|
-## Documentation
|
|
|
|
|
|
+## API Documentation
|
|
The `docker-compose` script will automatically build the API documentation. Use the following command to build it by hand.
|
|
The `docker-compose` script will automatically build the API documentation. Use the following command to build it by hand.
|
|
```sh
|
|
```sh
|
|
yarn doc
|
|
yarn doc
|