Skip to content

Commit

Permalink
edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
texano00 committed Mar 29, 2020
1 parent 6f2f840 commit b3ac870
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# covid19-people-counter-system
covid19-people-counter-system comes to share queue length to citizens or simply count people outside markets/shop.

This system analize images from city cameras, count people inside them, and show a real-time user interface.\
The software is entirely on-premise so it doesn't need internet access. This is the best way to **guarantee people privacy.**\
This system analizes images from city cameras, count people inside them, and show a real-time user interface wich can be included in an app or website through an `<iframe>`.\

The software is entirely on-premise so it doesn't need internet access. So sensitive data from original frame stay only inside the used server.\
This is the best way to **guarantee people privacy**.\
City cameras generally already exists or come from new installations by covid emergency.

# Who it is for
* cities
* public organizations
* universities

Or simply who owns cameras and wants to count people real-time.

# How it works
<img src="how.png"/>

# Demo UI
<img src="demo.gif"/>

Expand Down Expand Up @@ -68,7 +80,7 @@ FREQUENCE_MINUTES env variable set it.\
For example FREQUENCE_MINUTES=5 says to covid19-people-counter-system to get fresh images every 5 minutes from every images configured in config.json.


3. set up environment in Angular UI
# 3. set up environment in Angular UI

Edit `ui/src/environments/environment.prod.ts`

Expand All @@ -90,20 +102,28 @@ You need con set only:
* timezone: your timezone
* frequency: refresh frequence

4. set up your DNS\
# 4. set up your DNS
set up your A Record to point to your server IP

5. run it!\
# 5. run it!

`cd api && docker build . -t api:1 && cd ..`

`cd cron && docker build . -t cron:1 && cd ..`
```
# build api
cd api && docker build . -t api:1 && cd ..
# build cron
cd cron && docker build . -t cron:1 && cd ..
`cd ui && docker build -t ui-default:1 . && cd ..`
# build ui
cd ui && docker build -t ui-default:1 . && cd ..
`cd ingress && docker build . -t ingress:1 && cd ..`
# build ingress
cd ingress && docker build . -t ingress:1 && cd ..
`docker-compose up -d`
# run
docker-compose up -d
```

# Todo
* HTTPs support
Binary file added how.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b3ac870

Please sign in to comment.