Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Colony Task Importer #111

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions submissions/colonyTaskImporter-issue42.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Colony Task Importer

## Project Description
[Colony](https://colony.io/) is aiming to be a platform for open organizations, our project is aiming to be the task importer platform for Colony.

For these open organizations, they still need project management tools to help create and edit tasks in Colony, assign workers and evaluators for tasks, make it easy for evaluators to evaluate work and for workers to submit work and all users to claim payouts.

We don't think it's feasible to replace project tasks from existing issue tracking tools like Github issues, Jira or Trello with Colony Tasks directly. The reasons for this is that there can be a lengthy process from tasks are proposed until it's ironed out, estimated and accepted in a sprint. Also, a lot of proposed issues are closed before they ever reach a sprint (duplicate, out of scope, etc.). If this process was to take place on the blockchain / Colony, it could be an expensive (transaction fees), heavily bureaucratic, and ineffective process.

Therefore, we want to propose a solution where we keep using existing tools like GitHub, Jira, Trello, etc. as a filtering/caching layer and only bring the issues that are accepted, suitable specified, adequately discussed and ready to be estimated into the colony as a colony task.

We created a dApp for facilitating the process of creating colony tasks: users can import Github issues directly into existing colony domain as colony tasks, they can also create colony tasks from scratch.

## Project Vision
Our vision for this project is to become the place to view and interact with colonies, colony tasks and colony-related transactions. With our platform, people can easily create tasks in colony, and other people who want to contribute can easily browse and find tasks they want to work on.

After login (see instructions below), the dApp will place you into the "tasks" page where you can create tasks and import them from GitHub. We have future plans to support other task tracking services, as well as adding tools to this dApp. We've been calling it "Colony Portal". Have a look through the various placeholder pages listed on the sidebar, and get an idea of where we want to go with this in the future.

## Project Detail
### Issue
This closes the issue colonyHackathon#[42](https://github.com/JoinColony/colonyHackathon/issues/42)

### Repository
The project code lives at https://github.com/colonyportal/colonyPortal for dApp, and https://github.com/colonyportal/colonyPortalNetwork which includes Colony Network and scripts to set up a test colony and domain for demo purpose.

### Final Commit
The final commit of our project for submission is: https://github.com/colonyportal/colonyPortal/commit/1b5e439e5d85aedf252364bd4d15eeecbfe30d80

### Team
The project was built with contributions from:

- Asgeir Sognefest - @sogasg on Github
- Jordan Ellis - @JordanEllis6809 on Github
- Jingyu Zhang - @JingyuZ on Github
- Patrick Q - @patrickqpan on Github

## Demo Time!
We created a [demo video](https://drive.google.com/drive/folders/16lYt6R6R5j0ML-bW0go2bSYwnZfizy_z?usp=sharing) to go through the vision of colony task importer and how it works.

## Run App Locally
### Setup
```
$ git clone https://github.com/colonyportal/colonyPortal
$ cd ./colonyPortal
$ npm install
```

### Running Test Colony and Chain
```
$ npm run create:testColony
```

### Running App In Another Terminal
```
$ npm start
```
Run at http://localhost:3000/, and you can put colony address `0x4479B49eE193E6107Ed2Ad38A9b089Ee362542BA` to explore, which was created from test colony script.

---------

## Additional Material
We put together a presentation [slides](https://docs.google.com/presentation/d/1fKCLldCPohGKFMrzewkNC0JOUmHcdFll4o9Q81UtOyc/edit?usp=sharing) for project details and vision we mentioned in the demo video.