{"id":13555199,"url":"https://github.com/Grasia/teem","last_synced_at":"2025-04-03T08:30:42.171Z","repository":{"id":21279511,"uuid":"24595444","full_name":"Grasia/teem","owner":"Grasia","description":"Teem is a web tool and mobile app for collaboration in communities, which facilitates onboarding of newcomers","archived":false,"fork":false,"pushed_at":"2018-05-24T18:56:00.000Z","size":12404,"stargazers_count":50,"open_issues_count":81,"forks_count":25,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-18T15:21:45.425Z","etag":null,"topics":["angular","cbpps","collaboration","collaboration-system","collaborative-editing","collective-action","community","docker","javascript","newcomers","social-movements","swellrt","task-list","teem"],"latest_commit_sha":null,"homepage":"http://teem.works/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Grasia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-29T13:04:42.000Z","updated_at":"2025-02-02T06:31:14.000Z","dependencies_parsed_at":"2022-08-29T00:11:15.589Z","dependency_job_id":null,"html_url":"https://github.com/Grasia/teem","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grasia%2Fteem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grasia%2Fteem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grasia%2Fteem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Grasia%2Fteem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Grasia","download_url":"https://codeload.github.com/Grasia/teem/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246965382,"owners_count":20861853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","cbpps","collaboration","collaboration-system","collaborative-editing","collective-action","community","docker","javascript","newcomers","social-movements","swellrt","task-list","teem"],"created_at":"2024-08-01T12:03:04.771Z","updated_at":"2025-04-03T08:30:37.155Z","avatar_url":"https://github.com/Grasia.png","language":"JavaScript","readme":"# Teem\n\nTeem is a web tool and mobile app for collaboration in communities, collectives and social movements, which facilitates onboarding of newcomers. It is built within the [P2Pvalue project](http://p2pvalue.eu/) with a focus on [common-based peer production communities (CBPPs)](https://en.wikipedia.org/wiki/Commons-based_peer_production)\n\nFind more in:\nhttp://teem.works/\n\n[![Build Status](https://travis-ci.org/Grasia/teem.svg?branch=master)](https://travis-ci.org/Grasia/teem)\n[![Join the chat at https://gitter.im/P2Pvalue/teem](https://img.shields.io/gitter/room/nwjs/nw.js.svg\n)](https://gitter.im/P2Pvalue/teem)\n\n## Getting Started\n\nTo get you started you can simply clone the teem repository and install the dependencies:\n\n### Prerequisites\n\nYou need [git](http://git-scm.com/) to download the teem repository, [Node.js](http://nodejs.org/) (v4.2.x)\nto run the code, and [npm](https://www.npmjs.com/) (node.js's package manager) to install the dependencies.\n\nYou can use [Docker](https://docs.docker.com/installation/) (v1.9.x) to have\n[SwellRT](https://github.com/P2Pvalue/swellrt) running. SwellRT is a real-time\nfederated collaboration framework, which is installed and executed automatically by Teem though Docker.\n\nAdd your user into the `docker` group to have the necessary permissions. In GNU/Linux, try:\n\n```\nwget -qO- https://get.docker.com/ | sh\nsudo usermod -aG docker \u003cyour_user\u003e\n```\n\nAnd then restart your computer.\n\nFinally, you also need [Docker Compose](https://docs.docker.com/compose/) to set up the development environment. Follow the instructions at [Install Docker Compose](https://docs.docker.com/compose/install/)\n\n### Clone teem\n\nClone the teem repository using `git`:\n\n```\ngit clone https://github.com/Grasia/teem.git\ncd teem\n```\n\n### Install Dependencies\n\nWe have two kinds of dependencies in this project: tools and angular framework code.  The tools help\nus manage and test the application.\n\n* We get the tools we depend upon via `npm`, the node package manager.\n* We get the angular code via `bower`, a client-side code package manager.\n\nWe have preconfigured `npm` to automatically run `bower` so we can simply do:\n\n```\nnpm install\n```\n\nBehind the scenes this will also call `bower install`.  You should find that you have two new\nfolders in your project.\n\n* `node_modules` - contains the npm packages for the tools we need\n* `bower_components` - contains the angular framework files\n\n### Optional: Change configuration options\n\nYou can customize several options, such as server port, Weinre, SwellRT address via `config.js`\n\n```\ncp config.js.sample config.js\nedit config.js\n```\n\n### Run the Application\n\nWe have preconfigured the project with a simple development web server.  The simplest way to start\nthis server is installing `gulp` and running it.\n\n```\nsudo npm install -g gulp\ngulp\n```\n\nNow browse to the app at `http://localhost:8000/`\n\n\n## Testing\n\nThere are two kinds of tests in the teem application: Unit tests and End to End tests.\n\nTo run both, you need the Java Development Kit (such as OpenJDK 7), and run:\n\n```\ngulp test\n```\n\n### Unit Tests\n\nThe teem app comes preconfigured with unit tests. These are written in\nJasmine, which we run with the Karma Test Runner. We provide a Karma\nconfiguration file to run them.\n\n* the configuration is found at `karma.conf.js`\n* the unit tests are found in next to the code they are testing and are named as `..._test.js`.\n\n### End-to-end Tests\n\nThe teem app comes with end-to-end tests, again written in Jasmine. These tests\nare run with the Protractor End-to-End test runner.  It uses native events and has\nspecial features for Angular applications.\n\n* the configuration is found at `e2e-tests/protractor-conf.js`\n* the end-to-end tests are found in `e2e-tests/scenarios.js`\n\nProtractor simulates interaction with our web app and verifies that the application responds\ncorrectly. Therefore, our web server needs to be serving up the application, so that Protractor\ncan interact with it.\n\n## Contact\n\nFor more information on P2Pvalue project please check out http://p2pvalue.eu/\n","funding_links":[],"categories":["JavaScript","docker"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGrasia%2Fteem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FGrasia%2Fteem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FGrasia%2Fteem/lists"}