Giter Club home page Giter Club logo

dawa's Introduction

WARNING This repo is depricated and will no longer be maintained

Danmarks Adressers Web API - DAWA

This is the code repository for DAWA - Danmarks Adressers Web API.

Technical overview

This repository is a "monorepo" utilizing yarn workspaces. Lerna is used for scripting releases and running tests.

Setting up an environment

Running tests

First run yarn install to install dependencies and build the frontend code.

Create a configuration file that describes how the tests connect to the PostgreSQL database. The file should be stored in local-conf/test-conf.json5 .

The file should look something like this:

{
  test: {
    database_host: 'localhost',
    database_port: 5432,
    database_user: 'ahj',
    database_password: '',
  }
}

The user must have access to create and remove databases. Specifically, the following databases will be created automatically when running tests:

  • dawatest: Contains a small subset of production data used for testing
  • dawaempty: A completely empty database
  • dawaschema: A database where the complete DAWA schema has been loaded, but without any data in them.

When database and configuration is ready, run yarn test from the root of the repository.

Starting a server

Running the test sets up a test database "dawatest", which is populated with a small subset of real production data. There are scripts to start a local server against this database along with an appropriately configured local s3 stub.

Go to the directory packages/server and run yarn run start-servers. This will lauch a DAWA server on http://localhost:3000 as well as the S3 stub.

Support

Please ask any questions on digitaliser.dk.

Bug reports

Bugs or feature suggestions can be submitted on digitaliser.dk, or you are welcome to create a Github issue.

License

MIT/X11

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.