Get Involved

Try and test

  • Docker

    Get docker daemon running. Build or pull transtats image and get started.

    • Build the image (optional)

      • Clone the repo and build the image
        $ git clone https://github.com/transtats/transtats.git
        $ cd transtats
        $ sudo docker build -t transtats/transtats deploy/docker
        
    • Pull the image (No need to pull, if you have built the image)
      $ sudo docker pull docker.io/transtats/transtats
      
    • Run the image
      $ sudo docker run -d --name container_name -p 8080:8015 transtats/transtats
      
      or you can specify custom database credentials using environment variables
      $ sudo docker run -d --name container_name -p 8080:8015 -e DATABASE_NAME=db_name \
             -e DATABASE_USER=db_user -e DATABASE_PASSWD=db_passwd transtats/transtats
      
    • Application should be available at localhost:8080 with transtats | transtats as login credentials.

  • docker-compose

    • Install docker-compose

    • This will clone the repo and start transtats server
      $ git clone https://github.com/transtats/transtats.git
      $ cd transtats/deploy/docker-compose
      $ sudo docker-compose up
      
    • Application should be available at localhost:8080.

Hack and Develop

  • Install and run Ansible, Docker and Vagrant.

  • This will setup devel environment and run container plus, ssh into it
    $ sudo vagrant plugin install vagrant-hostmanager
    $ git clone https://github.com/transtats/transtats.git
    $ cd transtats
    $ sudo vagrant up
    $ sudo vagrant ssh
    
  • Run application
    $ cd /workspace
    $ make run
    
  • Hit localhost:8080 in browser

  • Create migrations make migrations

  • Run tests make lint test

  • Create cache make cache

  • Generate docs make docs

Contribution

  • The devel branch is the release actively under development.
  • The master branch corresponds to the latest stable release.
  • If you find any bug/issue or got an idea, open a GitHub issue.
  • Feel free to submit feature requests and/or bug fixes on devel branch.
  • Transtats uses CircleCI for tests.