Skip to content

spMohanty/geotagx-project-template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GeoTag-X project template

This is the template off which all projects for the GeoTag-X platform are based. To build and use it, you'll need to download it first

git clone https://github.com/spMohanty/geotagx_project_template.git
cd geotagx_project_template/

Setting up an isolated environment

It is highly recommended, but not necessary, that you install the template's requirements in an isolated environment to prevent any possible conflicts with your system. If you do not wish to create an isolated environment, head on over to the Installing requirements chapter.

First off, you will need to install virtualenv on your system

sudo pip install virtualenv

Then create a virtual environment in a directory of your choice; make sure you remember it! For this example, we create one in the env directory.

virtualenv env/

Finally, activate your new virtual environment

source env/bin/activate

Upon successful execution, the environment's directory (encased in parentheses) should be appended to your prompt, e.g. (env)name@domain:~$.

Installing requirements

To install the template requirements, run

pip install -r requirements.txt

If you are not installing the requirements in an isolated environment, you will need to run the previous command as a super-user

sudo pip install -r requirements.txt

To make sure the requirements have been correctly installed, run

python build.py

which should display the script's instruction manual.

PS. If you are using a virtual environment, you must activate it each time you you wish to run the build.py script.

Building the sample project

With the template requirements installed, it should be pretty straightforward building your own GeoTag-X project, provided you have the required files in place.

In case you do not have a working project, a sample project is provided. It is included as a submodule so you will need to fetch it before it can be used

git submodule update --init

The sample sample directory should now contain the entire sample project. To build it, run

python build.py sample/

The build.py script should produce a template.html file, i.e. the project's task presenter, in the project's folder. You can now setup the project via PyBossa's web interface or command line interface.

About

A generic template for geotagx project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 53.9%
  • HTML 22.2%
  • Python 14.7%
  • CSS 9.2%