Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 634 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (16 loc) · 634 Bytes
Raw

Contributing

To compile the app on your own local system:

  1. Make sure you have go installed.
  2. Clone this repository on to your computer.
  3. Switch to the folder.
  4. Run make
  5. ./dictpress is now available
  6. Follow the rest of "Installation" instruction in README.md

To configure the [db] section of config.toml, you will need a postgres instance running on your computer.

Setting up a test database

  1. Install postgresql.
  2. createuser and createdb. Fill config.toml with these details.
  3. psql -Upostgres dictpress -f sample/sample.sql

To run unit tests

  1. Prerequisite docker
  2. Run make test