https://github.com/dataesr/paysage-api

API de l'app paysage

https://github.com/dataesr/paysage-api

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (6.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

API de l'app paysage

Basic Info
  • Host: GitHub
  • Owner: dataesr
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 5.66 MB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Created over 4 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

Paysage API

license GitHub release (latest SemVer) Production deployment

Developpement

Install

npm install

Start the app in dev

npm start

Run tests

  • Run all tests

npm test

  • Run only one tests file

npm test my_file.test.js

  • Run test into a Docker container

npm run docker:test

Docker

To run the full app in a Docker container :

docker compose up --build

To stop the docker container :

docker compose down

To run the app being sure that everythiing else is down :

docker compose down && docker system prune -f && docker compose up --build

This run a docker container, with a MongoDB inside and the paysage-api app.

To acces the MongoDB from inside, use host : mongodb://mongo:27017.

To acces the MongoDB from outside, use host : mongodb://127.0.0.1:27017.

To access the Elasticsearch from inside, use host : http://elasticsearch:9200/.

To access the Elasticsearch from outside, use host : http://localhost:9200/.

To access the paysage-api from inside, use host : http://localhost:3000/.

To access the paysage-api from outside, use host : http://localhost:3003/.

To see the API docs, see : http://localhost:3003/docs/api/.

Documentation

https://dataesr.stoplight.io/docs/paysage-api-1/95201cd74824d-bienvenue-sur-la-documentation-paysage

Deployment

To deploy in production, simply run this command from your staging branch :

sh npm run deploy --level=[patch|minor|major]

:warning: Obviously, only members of the dataesr organization have rights to push on the repo.

GitHub Events

Total
  • Release event: 21
  • Watch event: 1
  • Push event: 98
  • Create event: 17
Last Year
  • Release event: 21
  • Watch event: 1
  • Push event: 98
  • Create event: 17