Skip to content

ESSolutions/ESSArch

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ESSArch Build Status codecov

Getting started

Using docker

Important

Elasticsearch requires vm.max_map_count to be at least 262144, see Install Elasticsearch with Docker for more information

  1. Enter the docker directory and start the services
$ cd docker
$ docker-compose build essarch
$ docker-compose up -d
  1. Wait for the essarch service to start by examining the logs
$ docker-compose logs -f essarch
  1. Finally visit http://localhost:8000 in your browser

Contributing

Please see CONTRIBUTING.md for information about contributing to the project.

Pre-commit hooks

To keep the source code style consistent we use multiple packages to warn about and fix any irregularities.

To automatically run these before commiting one can use pre-commit hooks. Pre-commit hooks in ESSArch are managed using pre-commit.

Install the application and run the following to install all hooks used in ESSArch.

$ pre-commit install

Now whenever you run git commit, all hooks defined in .pre-commit-config.yaml will verify the code.

Resources

Service and support

Service and support on ESSArch Core is regulated in maintenance contract with ES Solutions AB. A case is registered on the support portal http://projects.essolutions.se