smapshot api

• Project description
• Initial setup
• Develop with Docker Compose (recommended)
  • Requirements
  • Setup
  • Run the application
  • Run the automated tests
  • Useful commands
• Develop locally
  • Setup
  • Run the application
  • Run the automated tests
• Development guide

Project description

Smapshot is a crowdsourcing platform to geolocalize historical images in 3 dimension. Production version is available at https://smapshot.heig-vd.ch

This project contains the code of the smapshot API available live at https://smapshot.heig-vd.ch/api/v1/ The online documentation is available at https://smapshot.heig-vd.ch/api/v1/docs/

Initial setup

• Copy the .env.sample file to .env and adapt it to your local environment.

  If you are developing with Docker Compose, you do not need to configure the database connection, as the database is created and configured for you.

• You can download sample images from the Switch drive. Unzip the contents of the data.zip file into the public/data directory in this repository.

• Once you have set up the database in the following sections, if you do not have a super_admin user account (password super_admin), you can add one with:

  INSERT INTO public.users (first_name, last_name, email, username, date_registr, letter, lang, "password", roles, active)
  VALUES ('Franck', 'Dulin', 'super_admin@smapshot.ch', 'super_admin', now(), TRUE, 'fr','$2b$12$v80JamELNdJnvHyVAQrUZOaIRJJ2BI48vTsZop4s5mgoA9jbcX4Ni','{volunteer,super_admin}',TRUE);
  

Develop with Docker Compose (recommended)

Requirements

• Docker 18.09+.
• Docker Compose 1.24+.

Setup

Create and migrate the database:

npm run compose:migrate

Run the application

Visit http://localhost:1337 once the application has started.

Run the automated tests

Useful commands

Running the application with docker-compose up will also automatically re-generate the API documentation and re-run the linter on code changes.

Develop locally

You will need:

• A PostgreSQL 13+ server with the PostGIS extension.
• Node.js 12.x.
• Python 3+ and the pip package installer.

Setup

• Install Node.js dependencies:
  • Run npm ci on a fresh clone.
  • Or, run npm install to install new dependencies.

• Intall required Python tools:

  pip3 install opencv-python numpy scipy pymap3d
  

• Install the submodule git submodule update --init --recursive

• Create an empty database:

  psql
  > CREATE DATABASE smapshot;
  

• If you are using PostGIS 3+, you must also manually create the postgis and postgis_raster extensions before migrating the database:

  \connect smapshot
  CREATE EXTENSION postgis;
  CREATE EXTENSION postgis_raster;
  

• Migrate the database (assuming you have the correct database configuration in your .env file):

  npm run migrate
  

Run the application

• Run npm start to start the server once.
• Or, run npm run dev to start it with live reload. It will also keep the API documentation up to date and lint the code when it changes.

Then visit http://localhost:1337.

Run the automated tests

Create a separate test database, called smapshot-test by default. You can override the test database settings (e.g. DB_NAME, DB_HOST) in a .env.test file similar to your .env file.

Development guide

Read the development guide for more information.