Getting Started

sueastside edited this page Feb 3, 2017 · 4 revisions

###Where to start? Start at the beginning or introduce yourself :)
Join us on IRC at #peragro on freenode, mention Botanic or sueastside to get their attention. (Botanic is located in California, sueastside is in Belgium, so consider timezones, they sleep and work too, so show some patience :) )

###Introduction Name, degree, university, country seems to be on the standard list. Do you have any prior programming experience? Did you work on any other OpenSource projects before? Do you have some hobby projects of your own? ( links and pics! :) ) What technology, 3rd party libs did you use to create them?

Note that this isn't a job interview or anything, we're just asking out of curiosity and see how we could best lend your abilities to the project, what we value most is motivation and willingness to learn!

###What do you need to do?
The idea is that you pick a way to improve the project in some way, usually this is a feature or a collection thereof. The 'ideas' listed under GSoC-Ideas are just a suggestion, you are also welcome to suggest your own ideas for features (the cooler the better!) Discuss with us how you would tackle implementing said feature in a technical fashion; What algorithms would you use, what 3rd party libraries would you employ, ... Together we would then decide upon a deliverable (what is the extend of the features you'll add) and you would create a time plan to implement all of this in the GSoC time frame. Finally you write this all down thoroughly in your proposal document which you'll submit to us :)

Overview

You can follow the specific installation instructions for each module.

  • Peragro-AT: Peragro's Analyzers and Transcoders framework, the stand-alone heart of Peragro.
  • Peragro-index: ElasticSearch based indexing for the extracted meta-data.
  • Peragro-rest: The REST-api wrapper around all of Peragro's services.
  • Peragro-UI: the UI that pull it all together.
  • Django-project: Project management with tasks, milestones, follow and activity-stream.

Development

For development there are two options; we can provide you with a full ubuntu+Cloud9 environment with peragro pre-installed or you can install it yourself locally if you have a linux environment.

####Cloud IDE If you have a github account already, you can head over to Falkor

####Local Install (Linux) Please refer to the following page Development Installation