Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Grasia/teem
Teem is a web tool and mobile app for collaboration in communities, which facilitates onboarding of newcomers
https://github.com/Grasia/teem
angular cbpps collaboration collaboration-system collaborative-editing collective-action community docker javascript newcomers social-movements swellrt task-list teem
Last synced: 5 days ago
JSON representation
Teem is a web tool and mobile app for collaboration in communities, which facilitates onboarding of newcomers
- Host: GitHub
- URL: https://github.com/Grasia/teem
- Owner: Grasia
- License: agpl-3.0
- Created: 2014-09-29T13:04:42.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-05-24T18:56:00.000Z (over 6 years ago)
- Last Synced: 2024-08-01T12:34:08.529Z (3 months ago)
- Topics: angular, cbpps, collaboration, collaboration-system, collaborative-editing, collective-action, community, docker, javascript, newcomers, social-movements, swellrt, task-list, teem
- Language: JavaScript
- Homepage: http://teem.works/
- Size: 11.8 MB
- Stars: 49
- Watchers: 16
- Forks: 25
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - Grasia/teem - Teem is a web tool and mobile app for collaboration in communities, which facilitates onboarding of newcomers (javascript)
README
# Teem
Teem 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)
Find more in:
http://teem.works/
[](https://travis-ci.org/Grasia/teem)
[](https://gitter.im/P2Pvalue/teem)
## Getting Started
To get you started you can simply clone the teem repository and install the dependencies:
### Prerequisites
You need [git](http://git-scm.com/) to download the teem repository, [Node.js](http://nodejs.org/) (v4.2.x)
to run the code, and [npm](https://www.npmjs.com/) (node.js's package manager) to install the dependencies.
You can use [Docker](https://docs.docker.com/installation/) (v1.9.x) to have
[SwellRT](https://github.com/P2Pvalue/swellrt) running. SwellRT is a real-time
federated collaboration framework, which is installed and executed automatically by Teem though Docker.
Add your user into the `docker` group to have the necessary permissions. In GNU/Linux, try:
```
wget -qO- https://get.docker.com/ | sh
sudo usermod -aG docker
```
And then restart your computer.
Finally, 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/)
### Clone teem
Clone the teem repository using `git`:
```
git clone https://github.com/Grasia/teem.git
cd teem
```
### Install Dependencies
We have two kinds of dependencies in this project: tools and angular framework code. The tools help
us manage and test the application.
* We get the tools we depend upon via `npm`, the node package manager.
* We get the angular code via `bower`, a client-side code package manager.
We have preconfigured `npm` to automatically run `bower` so we can simply do:
```
npm install
```
Behind the scenes this will also call `bower install`. You should find that you have two new
folders in your project.
* `node_modules` - contains the npm packages for the tools we need
* `bower_components` - contains the angular framework files
### Optional: Change configuration options
You can customize several options, such as server port, Weinre, SwellRT address via `config.js`
```
cp config.js.sample config.js
edit config.js
```
### Run the Application
We have preconfigured the project with a simple development web server. The simplest way to start
this server is installing `gulp` and running it.
```
sudo npm install -g gulp
gulp
```
Now browse to the app at `http://localhost:8000/`
## Testing
There are two kinds of tests in the teem application: Unit tests and End to End tests.
To run both, you need the Java Development Kit (such as OpenJDK 7), and run:
```
gulp test
```
### Unit Tests
The teem app comes preconfigured with unit tests. These are written in
Jasmine, which we run with the Karma Test Runner. We provide a Karma
configuration file to run them.
* the configuration is found at `karma.conf.js`
* the unit tests are found in next to the code they are testing and are named as `..._test.js`.
### End-to-end Tests
The teem app comes with end-to-end tests, again written in Jasmine. These tests
are run with the Protractor End-to-End test runner. It uses native events and has
special features for Angular applications.
* the configuration is found at `e2e-tests/protractor-conf.js`
* the end-to-end tests are found in `e2e-tests/scenarios.js`
Protractor simulates interaction with our web app and verifies that the application responds
correctly. Therefore, our web server needs to be serving up the application, so that Protractor
can interact with it.
## Contact
For more information on P2Pvalue project please check out http://p2pvalue.eu/