Skip to content

Commit

Permalink
style: rename to ecosecrets (naturalsolutions#59)
Browse files Browse the repository at this point in the history
* style: renaming to ecosecrets

* style: change logo on connection page

* style: change name in github url
  • Loading branch information
MathildeNS authored Jan 19, 2024
1 parent 0f0a266 commit 3abb11a
Show file tree
Hide file tree
Showing 17 changed files with 124 additions and 68 deletions.
50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,37 @@
# GeoCam - *a web application enabling users to manage their camera traps data*
# ecoSecrets - _a web application enabling users to manage their camera traps data_

*GeoCam* is an open-source web application that aims to facilitate biodiversity studies that
use autonomous data collection devices such as camera traps.
_ecoSecrets_ is an open-source web application that aims to facilitate biodiversity studies that
use autonomous data collection devices such as camera traps.
This web-application is in development and offers several features that meet the needs
of biodiversity stakeholders:
of biodiversity stakeholders:

- project management: to delimit the studies according to their context
- management of study sites: to identify spatial scope
- device management: to specify technical characteristics of the tools used in the
field and their availability
field and their availability
- deployment management: to characterize spatio-temporal limits of data acquisition
- media management: to standardize and optimize the storage of collected data
- media processing: to enable the addition of annotations to the raw data

We would be delighted if you use it, or even contribute in its development.

A demo is available [here](https://demo.geocam.natural-solutions.eu). Don't hesitate to
A demo is available [here](https://demo.ecosecrets.natural-solutions.eu). Don't hesitate to
try it out! User : admin ; password : password

---

**Documentation (in french for now)**: [GeoCam documentation](https://natural-solutions.gitlab.io/geonature/annotation/)
**Documentation (in french for now)**: [ecoSecrets documentation](https://natural-solutions.gitlab.io/geonature/annotation/)

---

<p align="center">
<img src="https://github.com/naturalsolutions/geocam/actions/workflows/test_api.yml/badge.svg?branch=dev"/>
<img src="https://github.com/naturalsolutions/geocam/actions/workflows/build_frontend.yml/badge.svg?branch=dev"/>
<img src="https://github.com/naturalsolutions/geocam/actions/workflows/documentation.yml/badge.svg?branch=dev"/>
<img src="https://github.com/naturalsolutions/ecosecrets/actions/workflows/test_api.yml/badge.svg?branch=dev"/>
<img src="https://github.com/naturalsolutions/ecosecrets/actions/workflows/build_frontend.yml/badge.svg?branch=dev"/>
<img src="https://github.com/naturalsolutions/ecosecrets/actions/workflows/documentation.yml/badge.svg?branch=dev"/>
</p>

---

## Installation

### Prerequisite
Expand All @@ -42,23 +44,24 @@ Replace the `X.Y.Z` mention by the name of the release you want to install.

```
cd
wget https://github.com/naturalsolutions/geocam/archive/refs/tags/X.Y.Z.zip
wget https://github.com/naturalsolutions/ecosecrets/archive/refs/tags/X.Y.Z.zip
unzip X.Y.Z.zip
rm X.Y.Z.zip
mv geocam-X.Y.Z geocam/
mv ecosecrets-X.Y.Z ecosecrets/
```

### Settings

Copy the `.env.sample` inside the docker directory to `.env`:

```
cd geocam
cd ecosecrets
cp docker/.env.sample docker/.env
nano docker/.env
```

Edit freely this `.env` file to change credentials for instance. Here are the main parameters you usually want to modify:

- `ENV` : uncomment it to activate the production mode (only if your app has been configured with a domain name)
- `DOMAIN` : localhost, an IP address or a domain name (according to your context)
- `PROTOCOL` : modify it to "https" if you want to activate HTTPS
Expand All @@ -79,7 +82,6 @@ In the current version (`0.1.1`), you can't modify the `APP_USER` and the `APP_P

With the default settings, the app will run on `http://localhost:8889/` but the port of each service will be avaible to debug. This URL must be adapted to your context (depending on chosen protocol, domain and port).


## Sample data (for testing only)

Sample data can be generated by using the following command:
Expand All @@ -90,14 +92,14 @@ Sample data can be generated by using the following command:

## Authentication

GeoCam uses [Keycloak](https://www.keycloak.org/) version 21.1.0 as authentication system.
ecoSecrets uses [Keycloak](https://www.keycloak.org/) version 21.1.0 as authentication system.

A keycloak service is provided in the `docker-compose.yml` file. This also sets
up the keycloak instance to create a new realm, add clients (frontend and
backend) and create an admin user (credentials: **admin** / **password**).
backend) and create an admin user (credentials: **admin** / **password**).

For now, there is no right implemented in the app. This means that all users
have the same rights in GeoCam.
have the same rights in ecoSecrets.
The admin user created above can log into the app and manage users via the administration console of keycloak ([http://localhost:8889/auth](http://localhost:8889/auth) by default).

You can use your own keycloak instance if you wish, just change in the `.env`
Expand All @@ -114,21 +116,22 @@ command:
./scripts/docker.sh exec api pytest tests --cov-report html:/home/app/src/htmlcov --cov=src
```

The default config assumes that the backend is accessing the database through
The default config assumes that the backend is accessing the database through
the docker network (via "db" adress) which prevents backend tests from
being run locally (outside a container).

### API/backend documentation

The openapi documentation accessible via swagger is available here:

```
http://localhost:8889/api/v1/docs
```

### GeoCam app documentation (in french for now)
### ecoSecrets app documentation (in french for now)

The documentation is generated with mkdocs and is exposed on port 8133
The documentation is generated with mkdocs and is exposed on port 8133
to be able to work on it with automatic reloading.

```
Expand All @@ -143,7 +146,7 @@ We use 'black' and 'isort' for Python code-formatting, this is checked via a Git

## Licence

GeoCam
ecoSecrets
Copyright (C) 2023 Natural Solutions

This program is free software: you can redistribute it and/or modify
Expand All @@ -153,9 +156,8 @@ the Free Software Foundation, either version 3 of the License, or

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

along with this program. If not, see <https://www.gnu.org/licenses/>.
2 changes: 1 addition & 1 deletion docker/.env.sample
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PROTOCOL=http # either http or https
HTTP_HTTPS_PORT=8889 # either 80 or 443
CANONICAL_URL=${PROTOCOL}://${DOMAIN}:${HTTP_HTTPS_PORT}

# Login/password to log in into GeoCam
# Login/password to log in into ecoSecrets
APP_USER=admin
APP_PASSWORD=password

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# GeoCam
# ecoSecrets

## Bienvenue sur la documentation de GeoCam
## Bienvenue sur la documentation de ecoSecrets

---

## Introduction

GeoCam est un outil développé par Natural Solutions dans le but d'aider les acteurs de la biodiversité à exploiter le potentiel des pièges photographiques. Cet outil permet de faciliter la gestion et le traitement des données de biodiversité issues de ces pièges.
ecoSecrets est un outil développé par Natural Solutions dans le but d'aider les acteurs de la biodiversité à exploiter le potentiel des pièges photographiques. Cet outil permet de faciliter la gestion et le traitement des données de biodiversité issues de ces pièges.

![NS](./assets/logo_NS.jpg)
4 changes: 2 additions & 2 deletions docs/docs/technical_guide/keycloak.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Keycloak

Keycloak est la technologie utilisée dans GeoCam pour **gérer les droits et les utilisateurs**. Vous pouvez retrouver plus d'informations sur cette technologie [ici](https://www.keycloak.org/guides#getting-started).
Keycloak est la technologie utilisée dans ecoSecrets pour **gérer les droits et les utilisateurs**. Vous pouvez retrouver plus d'informations sur cette technologie [ici](https://www.keycloak.org/guides#getting-started).

L'interface administrateur permet à aux utlilisateurs administrateurs de gérer l'ensemble des aspects relatifs à Keycloak. Elle est accessible sur : `/auth/admin/geonature-annotation/console/`. La connexion se fait avec les mêmes identifiants que ceux de l'application.
L'interface administrateur permet à aux utlilisateurs administrateurs de gérer l'ensemble des aspects relatifs à Keycloak. Elle est accessible sur : `/auth/admin/geonature-annotation/console/`. La connexion se fait avec les mêmes identifiants que ceux de l'application.

Pour le moment, seule la gestion de l'authentification est implémentée dans l'application. Il n'est donc pas encore possible de donner des droits différents aux utilisateurs d'une instance. Cela signifie que tous les utilisateurs auront accès aux mêmes pages et pourront effectuer les mêmes opérations sur l'application.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/user/home.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Accueil de GeoCam
# Accueil de ecoSecrets

La page d'accueil présente des informations générales sur l'instance : le nombre de sites et de dispositifs, le nombre d'observations effectuées et le nombre de médias importés.
<br><br>
Expand All @@ -8,4 +8,4 @@ La figure suivante présente l'ensemble des fonctionnalités accessible depuis l
<br>
![homepage](../assets/homepage.png)

<center>_Page d'accueil de GeoCam_</center>
<center>_Page d'accueil de ecoSecrets_</center>
4 changes: 2 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: GeoCam
site_name: ecoSecrets

repo_name: geonature/annotaion
repo_url: https://gitlab.com/natural-solutions/geonature/annotation
Expand Down Expand Up @@ -46,7 +46,7 @@ nav:
- Introduction: index.md
- Guide utilisateur:
- Structure de la donnée au sein de l'application: user/data.md
- Commencer avec GeoCam: user/start.md
- Commencer avec ecoSecrets: user/start.md
- Page d'accueil: user/home.md
- Les projets: user/project.md
- Les sites: user/site.md
Expand Down
48 changes: 48 additions & 0 deletions frontend/public/assets/ecosecrets_logo_full_light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed frontend/public/assets/geocam-logo-dark.png
Binary file not shown.
Binary file removed frontend/public/assets/geocam-logo-icon.png
Binary file not shown.
Binary file removed frontend/public/assets/geocam-logo-light.png
Binary file not shown.
Loading

0 comments on commit 3abb11a

Please sign in to comment.