Synthesis Image Noise Detection on Distributed Data : A web app to collect data on noise detection by humans on images. https://diran.univ-littoral.fr/doc

rigwild 23eced6d79 Update docker for mongo 1 year ago
public 6c62d244ef init 1 year ago
server 23eced6d79 Update docker for mongo 1 year ago
src e8d1e55842 Added development environment 1 year ago
test 59ba564a8f Docker automatic testing 1 year ago
.dockerignore 59ba564a8f Docker automatic testing 1 year ago
.editorconfig 6c62d244ef init 1 year ago
.eslintrc.js 083501e645 Image cutting works `/getImageExtracts`. Exported getImage 1 year ago
.gitignore 1b7414db58 Add of mongo DB docker instance 1 year ago
LICENSE 90a7f736ab Added readme and mit license 1 year ago
README.md a9de24c6aa MongoDB database support. Fixed logging objects 1 year ago
babel.config.js 6c62d244ef init 1 year ago
back.Dockerfile c60f4973b2 Added WebSocket support 1 year ago
config.js 23eced6d79 Update docker for mongo 1 year ago
docker-compose.frontapp_only.yml 72cd80e1e6 Release hotfix 1 year ago
docker-compose.yml 23eced6d79 Update docker for mongo 1 year ago
front.Dockerfile 72cd80e1e6 Release hotfix 1 year ago
package.json fc49583312 version bump 1 year ago
webhook_deploy_gogs.js 69e8a47a76 Fixed webhook script and docker port 1 year ago
yarn.lock a9de24c6aa MongoDB database support. Fixed logging objects 1 year ago

README.md

Antoine_Internship

A web app to collect data on noise detection by humans on images.

Download project

git clone https://gogs.univ-littoral.fr/Prise3D/Antoine_Internship.git
cd Antoine_Internship

Run as a Docker instance

Configure

Use the following environment variables to configure the application.

Option Default value Description Server Client
PORT 5000 The port used by the started application
SERVE_CLIENT true Should the server serve client (Fully local application) ⬜️
IMAGES_PATH ./images The directory where the images are stored (absolute path if changed ⚠️) ⬜️
MONGO_URI mongodb://localhost/webexpe MongoDB database connection URI ⬜️

Configure more deeply the way the app works by modifying config.js.

Option Default value Description
apiPrefix /api The url prefix for the API
imageServedUrl /api/images The url prefix from where the images are served
serverPort 5000 The port used by the server
mongoDatabaseURI mongodb://localhost/webexpe MongoDB database connection URI
imagesPath ./images The directory where the images are stored
serveClient true Should the server serve client files from the /dist directory
fileNameConvention /^(.*)?_([0-9]{2,})\.(.*)$/ File name convention for images
extractsDirName extracts Name of the directory containing extracts
sceneFileNameBlackList ['config', 'seuilExpe', 'extracts'] Files to ignore in scenes
logger Logs : logs/server.combined.log Errors : logs/server.error.log Default application logger
wsLogger Logs : logs/ws.log Errors : logs/ws.error.log WebSocket logger configuration
dbLogger Logs : logs/db.log Errors : logs/db.error.log Database logger configuration

Run server + client

Linux

PORT=8080 SERVE_CLIENT=true IMAGE_PATH=/var/images docker-compose up

Windows

SET PORT=8080
SET SERVE_CLIENT=true
SET IMAGE_PATH=C:\my\images
docker-compose up

Run server only

Linux

SERVE_CLIENT=false docker-compose up

Windows

SET SERVE_CLIENT=false
docker-compose up

Run client only

docker-compose -f docker-compose.frontapp_only.yml up

Notice

New version Docker build

When using a new version of the project, you need to re-build the application with Docker.

# Server / Server + client versions
docker-compose build

# Client only version
docker-compose -f docker-compose.frontapp_only.yml build

Using Windows

When using Windows, it may happen that you can't properly run the containers because of Windows's path system being different. To circumvant this problem, you can do the following steps.

  1. On Command Line: "set COMPOSE_CONVERT_WINDOWS_PATHS=1";
  2. Restart Docker for Windows;
  3. Go to Docker for Windows settings > Shared Drives > Reset credentials > select drive > Apply;
  4. Reopen Command Line;
  5. Kill the Containers;
  6. Rerun the Containers.

Run on the file system

Project setup

Install project's dependencies.

yarn install

If this is a production build, set the NODE_ENV environment variable to production to enhance performance.

Linux

export NODE_ENV=production

Windows

SET NODE_ENV=production

API

Run the server

yarn run server:start

Run the server with hot-reload for development

yarn run server:dev

Automatically fix the API code syntax with ESLint

yarn run server:lint

Client

Compile and minify for production

Files will be built to the dist/ directory.

yarn run app:build

Run a hot-reload server for client development

yarn run app:dev

Automatically fix the client code syntax with ESLint

yarn run app:lint

Automated deployment

The app can be automatically deployed when a push event is sent to the master branch using Gogs. Open a port to the web and start webhook_deploy_gogs.js.

WEBHOOK_SECRET=your_webhook_secret WEBHOOK_PORT=5000 SERVE_CLIENT=true PORT=8080 node webhook_deploy_gogs.js

You can pass any parameters to the script, they will be passed to the Docker instance. The following are required.

Option Description
WEBHOOK_SECRET The secret set on Gogs to verify the identity
WEBHOOK_PORT The port the script is listening to

Running tests

The docker-compose script will automatically run tests. Use the following command to run them by hand.

yarn test

License

The MIT license