cleaning up

README.md

@@ -0,0 +1,64 @@
+# Timtec
+
+[![Build Status](https://drone.io/github.com/hacklabr/timtec/status.png)](https://drone.io/github.com/hacklabr/timtec/latest)
+[![Coverage](https://coveralls.io/repos/hacklabr/timtec/badge.png)](https://coveralls.io/r/hacklabr/timtec)
+
+
+## Getting Started
+
+We provide a vagrant file for easy dev environment creation. Install
+[Vagrant](http://www.vagrantup.com/) and on the main directory run:
+
+    vagrant up
+
+See the Vagrantfile and script folder for more details.
+
+## Dependencies
+
+
+* Python 2.7 with virtualenv and pip
+* build essentials and many dev packages if on apt/rpm based systems
+    * libpq-dev, libjpeg-dev, libpng12-dev, build-essential, python-dev, gettext
+* nodejs (0.10+) (you will need a ppa for ubuntu < 14.04)
+
+### Python env
+
+
+* create a Python 2.X virtualenv
+
+    `virtualenv ../timtec-env`
+
+* activate the virtual env
+
+    `source ../timtec-env/bin/activate`
+
+* run make
+
+    `make`
+
+* run the django devel server
+
+    `./manage.py runserver`
+
+## Running Tests
+
+We made a bunch of tests for the system. They are separated into python tests
+(that includes selenium full stack tests) and Karma/AngularJS tests. To run all
+of them together just type
+
+    make all_tests
+
+remember that you need to have your virtualenv activated and has installed
+everything from the `dev-requirements.txt` file.
+
+### python
+
+Activate virtual env, then:
+
+    make python_tests
+
+### Angular
+
+In the root of repository:
+
+    make karma_tests

Vagrantfile

@@ -7,123 +7,9 @@ TIMTEC_USER = "vagrant"
 VAGRANTFILE_API_VERSION = "2"
 
 Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  # All Vagrant configuration is done here. The most common configuration
-  # options are documented and commented below. For a complete reference,
-  # please see the online documentation at vagrantup.com.
-
-  # Every Vagrant virtual environment requires a box to build off of.
-  # config.vm.box = "chef/debian-7.6"
   config.vm.box = "ubuntu/trusty64"
   config.vm.provision :shell, path: "scripts/bootstrap-ubuntu.sh", privileged: false, keep_color: true
-
-  # Disable automatic box update checking. If you disable this, then
-  # boxes will only be checked for updates when the user runs
-  # `vagrant box outdated`. This is not recommended.
-  # config.vm.box_check_update = false
-
-  # Create a forwarded port mapping which allows access to a specific port
-  # within the machine from a port on the host machine. In the example below,
-  # accessing "localhost:8080" will access port 80 on the guest machine.
   config.vm.network "forwarded_port", guest: 8080, host: 8000
-
-  # Create a private network, which allows host-only access to the machine
-  # using a specific IP.
-  # config.vm.network "private_network", ip: "192.168.33.10"
-
-  # Create a public network, which generally matched to bridged network.
-  # Bridged networks make the machine appear as another physical device on
-  # your network.
-  # config.vm.network "public_network"
-
-  # If true, then any SSH connections made will enable agent forwarding.
-  # Default value: false
-  # config.ssh.forward_agent = true
-
   config.ssh.username = TIMTEC_USER
-
-  # Share an additional folder to the guest VM. The first argument is
-  # the path on the host to the actual folder. The second argument is
-  # the path on the guest to mount the folder. And the optional third
-  # argument is a set of non-required options.
-  # config.vm.synced_folder "./", "/timtec/", owner: TIMTEC_USER, group: TIMTEC_USER, create: true
   config.vm.synced_folder "./", "/home/" + TIMTEC_USER  + "/timtec/", create: true
-
-  # Provider-specific configuration so you can fine-tune various
-  # backing providers for Vagrant. These expose provider-specific options.
-  # Example for VirtualBox:
-  #
-  # config.vm.provider "virtualbox" do |vb|
-  #   # Don't boot with headless mode
-  #   vb.gui = true
-  #
-  #   # Use VBoxManage to customize the VM. For example to change memory:
-  #   vb.customize ["modifyvm", :id, "--memory", "1024"]
-  # end
-  #
-  # View the documentation for the provider you're using for more
-  # information on available options.
-
-  # Enable provisioning with CFEngine. CFEngine Community packages are
-  # automatically installed. For example, configure the host as a
-  # policy server and optionally a policy file to run:
-  #
-  # config.vm.provision "cfengine" do |cf|
-  #   cf.am_policy_hub = true
-  #   # cf.run_file = "motd.cf"
-  # end
-  #
-  # You can also configure and bootstrap a client to an existing
-  # policy server:
-  #
-  # config.vm.provision "cfengine" do |cf|
-  #   cf.policy_server_address = "10.0.2.15"
-  # end
-
-  # Enable provisioning with Puppet stand alone.  Puppet manifests
-  # are contained in a directory path relative to this Vagrantfile.
-  # You will need to create the manifests directory and a manifest in
-  # the file default.pp in the manifests_path directory.
-  #
-  # config.vm.provision "puppet" do |puppet|
-  #   puppet.manifests_path = "manifests"
-  #   puppet.manifest_file  = "site.pp"
-  # end
-
-  # Enable provisioning with chef solo, specifying a cookbooks path, roles
-  # path, and data_bags path (all relative to this Vagrantfile), and adding
-  # some recipes and/or roles.
-  #
-  # config.vm.provision "chef_solo" do |chef|
-  #   chef.cookbooks_path = "../my-recipes/cookbooks"
-  #   chef.roles_path = "../my-recipes/roles"
-  #   chef.data_bags_path = "../my-recipes/data_bags"
-  #   chef.add_recipe "mysql"
-  #   chef.add_role "web"
-  #
-  #   # You may also specify custom JSON attributes:
-  #   chef.json = { mysql_password: "foo" }
-  # end
-
-  # Enable provisioning with chef server, specifying the chef server URL,
-  # and the path to the validation key (relative to this Vagrantfile).
-  #
-  # The Opscode Platform uses HTTPS. Substitute your organization for
-  # ORGNAME in the URL and validation key.
-  #
-  # If you have your own Chef Server, use the appropriate URL, which may be
-  # HTTP instead of HTTPS depending on your configuration. Also change the
-  # validation key to validation.pem.
-  #
-  # config.vm.provision "chef_client" do |chef|
-  #   chef.chef_server_url = "https://api.opscode.com/organizations/ORGNAME"
-  #   chef.validation_key_path = "ORGNAME-validator.pem"
-  # end
-  #
-  # If you're using the Opscode platform, your validator client is
-  # ORGNAME-validator, replacing ORGNAME with your organization name.
-  #
-  # If you have your own Chef Server, the default validation client name is
-  # chef-validator, unless you changed the configuration.
-  #
-  #   chef.validation_client_name = "ORGNAME-validator"
 end

scripts/bootstrap-ubuntu.sh

@@ -9,10 +9,6 @@ sudo apt-get install -y libpq-dev libjpeg-dev libpng12-dev build-essential pytho
 
 sudo ln -s /usr/bin/nodejs /usr/local/bin/node
 
-# Database
-# For timtec main project, we use postgresql to simulate prodution enviroment
-# TODO: the developer version should use lighter databases, like sqlite.
-
 sudo apt-get install -y postgresql
 sudo su - postgres -c "createuser -d ${TIMTEC_USER}"
 createdb timtec