Skip to content

Latest commit

 

History

History
107 lines (77 loc) · 4.39 KB

README.md

File metadata and controls

107 lines (77 loc) · 4.39 KB
Raw

Join the chat at https://gitter.im/Cloud-CV/EvalAI Build Status Coverage Status Requirements Status Code Health Code Climate Documentation Status

EvalAI is an open source web application that helps researchers, students and data-scientists to create, collaborate and participate in various AI challenges organized round the globe.

How to setup

Setting up EvalAI on your local machine is really easy. Follow this guide to setup your development machine.

  1. Install python 2.x, git, postgresql version >= 9.4, RabbitMQ and virtualenv, in your computer, if you don't have it already. If you are having trouble with postgresql on Windows check this link postgresqlhelp.

  2. Get the source code on your machine via git.

    git clone https://github.com/Cloud-CV/EvalAI.git evalai

  3. Create a python virtual environment and install python dependencies.

    cd evalai
virtualenv venv
source venv/bin/activate  # run this command everytime before working on project
pip install -r requirements/dev.txt

  4. Rename settings/dev.sample.py as dev.py and change credential in settings/dev.py

    cp settings/dev.sample.py settings/dev.py

    Use your postgres username and password for fields USER and PASSWORD in dev.py file.

  5. Create an empty postgres database and run database migration.

    sudo -i -u (username)
createdb evalai
python manage.py migrate --settings=settings.dev

  6. Seed the database with some fake data to work with.

    python manage.py seed --settings=settings.dev

    This command also creates a superuser(admin), a host user and a participant user with following credentials.

    SUPERUSER- username: admin password: password
    HOST USER- username: host password: password
    PARTICIPANT USER- username: participant password: password

  7. That's it. Now you can run development server at http://127.0.0.1:8000 (for serving backend)

    python manage.py runserver --settings=settings.dev

  8. Open a new terminal window with node(6.9.2) and ruby(gem) install on your machine and type

    npm install
bower install

    If you running npm install behind a proxy server, use

    npm config set proxy http://proxy:port

  9. Now to connect to dev server at http://127.0.0.1:8888 (for serving frontend)

    gulp dev:runserver

  10. That's it, Open web browser and hit the url http://127.0.0.1:8888.

  11. (Optional) If you want to see the whole game into play, then start the RabbitMQ worker in a new terminal window using the following command that consumes the submissions done for every challenge:

    python scripts/workers/submission_worker.py

Contribution guidelines

If you are interested in contributing to EvalAI, follow our contribution guidelines.