Skip to content
This repository has been archived by the owner. It is now read-only.
master
Go to file
Code

Latest commit

 

Git stats

Files

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

README.md

An ElasticSearch autocomplete Django server

Build Status

Documentation

Documentation on Read the Docs

Running tests

To run the unit tests run:

./manage.py test

Using Docker

First you need to create your own .env file. It should look something like this:

DEBUG=True
SECRET_KEY=somethingx
#DATABASE_URL=postgresql://localhost/autocompeter
ALLOWED_HOSTS=localhost
ES_CONNECTIONS_URLS=elasticsearch:9200
AUTH0_CLIENT_SECRET="optional"

Simply run:

docker-compose build
docker-compose up

And now you should have a server running on http://localhost:8000

And to run the tests with Docker:

docker-compose run web /usr/local/bin/python manage.py test

Writing documentation

If you want to work on the documentation, cd into the directory ./doc and make sure you have mkdocs pip installed. (see ./requirements.txt).

Then simple run:

mkdocs build
open site/index.html

If you have a bunch of changes you want to make and don't want to run mkdocs build every time you can use this trick:

mkdocs serve
open http://localhost:8000/
You can’t perform that action at this time.