Open Decision

by fbennets

GitHub Readme.md

Open Decision

Open Decision is an Open-Source Decision Automation System, that is optimized for legal processes. The system will be used to build a platform to provide free legal advice for consumers.

Further information about the project on www.open-decision.org

Table of content

Participate

We are happy about any contributions and currently preparing everything for a smooth process. Please join the Slack-Channel to stay up to date.

For Experts, Lawyers, Designers, Ambassadors & Enthusiasts

Non-code contributions are soon coordinated via Trello. For the moment, please contact us on Slack or Email if you want to contribute.

For Developers

Feel free to pick an issue, open a bug report, feature request or fork the project. We are open to any input or suggestions on how to bring the project forward.

Deploy in the Cloud

With one click, you can deploy your own instance of Open Decision for free on Heroku.

Deploy

Make sure to replace the SECRET_KEY-variable as soon as possible to secure your instance. Click here to generate a unique secret key and replace it in the Heroku Dashboard.

Local Set-up

The instructions down below will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You need to install Python and the package manager PIP. When you install Python <= 3.4 from the official website, PIP is already installed.

# Install virtual enviroment
pip install virtualenv

Installation

First set-up and start the virtual environment.

# Create virtualenv
virtualenv -p python3 od

# Start environment
source od/bin/activate

Now clone the repo to the "src"-folder or download the repo as zip, unpack the folder, move it into the folder of your environment and rename it to "src".

# Clone repository to current directory
cd od
git clone https://github.com/fbennets/open-decision.git src

Next install the requirements.

# Install dependencies
cd src
pip install -r requirements-dev.txt

Now start the Django development server and enjoy!

# Start the development server
python manage.py runserver

Access the server at http://localhost:8000 or http://127.0.0.1:8000.

Now you can create an account and start playing around or use the demo-account to get a first impression:

User: test@test.com
Password: Testuser1

If the demo-account doesn't work, simply create an own one, you don't need to use a valid email adress.

Built With

  • Django - The web framework used

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links