Skip to content

Commit

Permalink
Prepared 0.4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
pospielov committed Nov 29, 2020
1 parent 1fd0446 commit 9ad92d5
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 16 deletions.
12 changes: 12 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
registry=exadel/
postgres_password=postgres
postgres_domain=compreface-postgres-db
postgres_port=5432
email_host=smtp.gmail.com
email_username=
email_from=
email_password=
enable_email_server=false
save_images_to_db=true
compreface_api_java_options="-Xmx8g"
compreface_admin_java_options="-Xmx8g"
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,4 @@
build/

### VS Code ###
.vscode/

### Property files ###
.env
.vscode/
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ CompreFace is an application for facial recognition that can be integrated as a
Our method is based on deep neural networks, which is one of the most popular facial recognition methods and provides a convenient API for model training and face recognition. We also provide an easy-to-understand roles system with which you can easily control who has access to the model.
Every user can create their own models and train them on different subsets of input data.

## Feedback survey

We are constantly improving our product. But for better understanding which features we should add or improve we need your help!
Feedback form is totally anonymous, it will take just 2 minutes of your time to answer the questions:
https://forms.gle/ybAEPc3XmzEcpv4M8

## Features

Expand All @@ -52,25 +56,31 @@ CompreFace:
- Starts quickly with one docker command



## Getting started

To get started:
1. Install Docker
#### To get started (Linux, MacOS):
1. Install Docker and Docker-Compose
2. Download the archive from our latest release: https://github.com/exadel-inc/CompreFace/releases
3. Unzip the archive
4. Run Docker
5. Windows search bar-> cmd->in the Command prompt-> cd ->paste the path to the extracted zip folder
6. Run command: _docker-compose up --build_
7. Open https://localhost:8000/
4. Run command: _docker-compose up -d_
5. Open in your browser: https://localhost:8000/login

Getting started for Contributors:
#### Getting started for Contributors:

1. Install Docker
1. Install Docker and Docker-Compose
2. Clone repository
3. Open dev folder
4. Run command: _docker-compose up --build_
5. Open https://localhost:8000/
5. Open in your browser: https://localhost:8000/login

#### To get started (Windows):
1. Install Docker
2. Download the archive from our latest release: https://github.com/exadel-inc/CompreFace/releases
3. Unzip the archive
4. Run Docker
5. Windows search bar-> cmd->in the Command prompt-> cd ->paste the path to the extracted zip folder
6. Run command: _docker-compose up -d_
7. Open https://localhost:8000/login

** Tips for Windows** (use Git Bash terminal)

Expand All @@ -85,8 +95,6 @@ Getting started for Contributors:
9. Run _sh start--dev.sh_ and make sure https://localhost:4200/ starts


## Simple tutorial of usage

## Simple tutorial of usage

Step 1. You need to sign up to the system (First user in CompareFace admin has Owner role, but it is possible to change the role) and then LogIn with created account or just use the existing one. After that system redirects you to the main page.
Expand Down
61 changes: 61 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
version: '3.4'

volumes:
postgres-data:

services:
compreface-postgres-db:
image: postgres:11.5
container_name: "compreface-postgres-db"
environment:
- POSTGRES_USER=postgres
- POSTGRES_PASSWORD=${postgres_password}
- POSTGRES_DB=frs
volumes:
- postgres-data:/var/lib/postgresql/data

compreface-admin:
image: ${registry}compreface-admin
container_name: "compreface-admin"
environment:
- POSTGRES_PASSWORD=${postgres_password}
- POSTGRES_URL=jdbc:postgresql:https://${postgres_domain}:${postgres_port}/frs
- SPRING_PROFILES_ACTIVE=dev
- ENABLE_EMAIL_SERVER=${enable_email_server}
- EMAIL_HOST=${email_host}
- EMAIL_USERNAME=${email_username}
- EMAIL_FROM=${email_from}
- EMAIL_PASSWORD=${email_password}
- ADMIN_JAVA_OPTS=${compreface_admin_java_options}
depends_on:
- compreface-postgres-db
- compreface-api

compreface-api:
image: ${registry}compreface-api
container_name: "compreface-api"
depends_on:
- compreface-postgres-db
environment:
- POSTGRES_PASSWORD=${postgres_password}
- POSTGRES_URL=jdbc:postgresql:https://${postgres_domain}:${postgres_port}/frs
- SPRING_PROFILES_ACTIVE=dev
- API_JAVA_OPTS=${compreface_api_java_options}
- SAVE_IMAGES_TO_DB=${save_images_to_db}

compreface-fe:
image: ${registry}compreface-fe
volumes:
- ${compreface-fe-volume}
container_name: "compreface-ui"
ports:
- "8000:80"
depends_on:
- compreface-api
- compreface-admin

compreface-core:
image: ${registry}compreface-core
container_name: "compreface-core"
environment:
- ML_PORT=3000

0 comments on commit 9ad92d5

Please sign in to comment.