Skip to content

Commit c3febdb

Browse files
authored
docs(README): update README (#515)
1 parent 0752ec1 commit c3febdb

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
11
# Graasp App: collaborative ideation
22

3+
4+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
35
![GitHub release (with filter)](https://img.shields.io/github/v/release/graasp/graasp-app-collaborative-ideation)
46

5-
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/graasp/graasp-app-collaborative-ideation/deploy-dev.yml?label=development)
6-
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/graasp/graasp-app-collaborative-ideation/deploy-stage.yml?label=staging)
7-
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/graasp/graasp-app-collaborative-ideation/deploy-prod.yml?label=production)
7+
[![Deploy to development environment](https://github.com/graasp/graasp-app-collaborative-ideation/actions/workflows/deploy-dev.yml/badge.svg)](https://github.com/graasp/graasp-app-collaborative-ideation/actions/workflows/deploy-dev.yml)
8+
[![Deploy to staging environment](https://github.com/graasp/graasp-app-collaborative-ideation/actions/workflows/deploy-stage.yml/badge.svg)](https://github.com/graasp/graasp-app-collaborative-ideation/actions/workflows/deploy-stage.yml)
9+
[![Deploy to production environment](https://github.com/graasp/graasp-app-collaborative-ideation/actions/workflows/deploy-prod.yml/badge.svg)](https://github.com/graasp/graasp-app-collaborative-ideation/actions/workflows/deploy-prod.yml)
810

9-
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
1011

1112
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=graasp_graasp-app-collaborative-ideation&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=graasp_graasp-app-collaborative-ideation)
12-
1313
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=graasp_graasp-app-collaborative-ideation&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=graasp_graasp-app-collaborative-ideation)
14-
1514
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=graasp_graasp-app-collaborative-ideation&metric=bugs)](https://sonarcloud.io/summary/new_code?id=graasp_graasp-app-collaborative-ideation)
16-
1715
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=graasp_graasp-app-collaborative-ideation&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=graasp_graasp-app-collaborative-ideation)
1816

17+
![typescript version](https://img.shields.io/github/package-json/dependency-version/graasp/graasp-app-collaborative-ideation/typescript)
18+
19+
# About
20+
21+
The **Collaborative Ideation** app in Graasp was made to organise blended and online activities where participants can share their inputs and react on them in real-time. This app was designed and implemented inside the [Graasp](https://graasp.org) platform and is not independant from it.
22+
23+
## Related publications
24+
25+
This app was presented or used in the following publications:
26+
27+
- (_preprint_) La Scala, J. A., Bartłomiejczyk, N., Gillet, D., & Holzer, A. C. (2025). Fostering Innovation with Generative AI: A Study on Human-AI Collaborative Ideation and User Anonymity. 58th Hawaii International Conference on System Sciences. https://infoscience.epfl.ch/handle/20.500.14299/241341
28+
1929
# Development
2030

31+
This app being currently part of the general Graasp platform, you will find the most up-to-date general informations on the development of Graasp apps in [the official Graasp technical documentation](https://graasp.github.io/docs/developer/apps/).
32+
2133
## Installation
2234

23-
Clone this repository.
35+
Clone this repository. To use and test the collaboration mechanism, we recommend to also install [the full Graasp stack](https://github.com/graasp/graasp/blob/main/README.md).
2436

2537
## Running the app
2638

@@ -35,6 +47,10 @@ VITE_VERSION=latest
3547
VITE_WS_HOST=ws://localhost:3000/ws
3648
```
3749

50+
To serve the app with the _full Graasp stack_, use `yarn dev`. If you want to try the app without the stack, use `yarn dev:mock`.
51+
52+
> ⚠️ If you don't use the full Graasp stack, please note that you won't be able to save the state of the application and use the collaboration.
53+
3854
## Running the tests
3955

4056
Create a `.env.test` file with the following content:
@@ -49,3 +65,7 @@ VITE_VERSION=latest
4965
# dont open browser
5066
BROWSER=none
5167
```
68+
69+
# Contributors
70+
71+
This app was designed, implemented, and is currently maintained by [Jérémy La Scala](https://people.epfl.ch/jeremy.lascala) (@swouf) from École Polytechnique Fédérale de Lausanne.

0 commit comments

Comments
 (0)