Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 2.61 KB

README.md

File metadata and controls

95 lines (59 loc) · 2.61 KB

Build Status Code Climate Test Coverage

Lily

Lily is an open source CRM project built on top of Django, AngularJS and Elasticsearch.

Status

Active/Maintained

Usage

Check out the Sphinx docs for detailed information

Requirements

Installation & running

  1. Checkout the Lily project and install gulp dependencies.
git clone [email protected]:HelloLily/hellolily.git
cd hellolily
npm install
  1. Build the Docker image.

To retreive images from DockerHub (uploaded by TravisCI) use:

docker-compose pull

To build your own images locally you can use

docker-compose -f docker-compose.yml -f docker-compose.new-build.yml build

This command needs to run every time the Dockerfile, requirements or patches are adjusted. Good practice would be to run it every time the git repo is updated. If nothing changed, the command will complete almost instantly.

  1. Do a first time migration of the models.
docker-compose run web python manage.py migrate
  1. Create a search index for ElasticSearch.
docker-compose run web python manage.py index
  1. Populate the database with some testdata.
docker-compose run web python manage.py testdata

Running

Run the Django development server along with dependent containers.

docker-compose run --service-ports web

You can then log in using the credentials creating in step 5 of the installation process.

Contributing

See the CONTRIBUTING.md file on how to contribute to this project.

Contributors

See the CONTRIBUTORS.md file for a list of contributors to the project.

Get in touch with a developer

If you want to report an issue see the CONTRIBUTING.md file for more info.

We will be happy to answer your other questions at [email protected].

License

Lily is made available under the GNU General Public License v3.0 license. See the LICENSE file for more info.