Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.51 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.51 KB
Raw

frequency-classes

Searchtool to return words for a specific frequency class

Features

  • Search words to a specific frequency class
  • Export the words for a specific frequency class

Requirements

This project need the following environment in order to run

  • Docker version 18.03.0-ce, build 0520e24
  • docker-compose version 1.20.1, build 5d8c71b

Installation

  1. git clone [email protected]:janz93/frequency-classes.git
  2. cd frequency-classes
  3. docker-compose build --pull
  4. docker-compose up

docker-compose ps will tell you, on which local port the application binds.

Testing

This is a TDD project.

To fight bugs and have best practice code we use:

Launch tests

docker-compose build --pull
docker-compose -f docker-compose.test.yml run --rm web

Bugs

In case of finding bug: Please post any bugs, questions, or ideas on our issues page.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Creative Commons License This work is licensed under a Creative Commons Attribution 4.0 International License.