Skip to content

Commit 30ff35d

Browse files
authored
docs: update citation and README (#526)
1 parent ea9f048 commit 30ff35d

File tree

2 files changed

+57
-18
lines changed

2 files changed

+57
-18
lines changed

CITATION.cff

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,46 @@
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
3+
14
cff-version: 1.2.0
2-
message: If you use this software, please cite it as below.
5+
title: Collaborative Ideation
6+
message: >-
7+
If you use this software, please cite it using these
8+
metadata.
9+
type: software
310
authors:
4-
- family-names: La Scala
5-
given-names: Jérémy
11+
- given-names: Jérémy
12+
family-names: La Scala
613
7-
website: https://github.com/swouf
8-
orcid: https://orcid.org/0000-0002-8057-7787
9-
title: "Collaborative ideation"
10-
version: 2.9.3
11-
date-released: 2024-05-15
14+
orcid: 'https://orcid.org/0000-0002-8057-7787'
15+
affiliation: École Polytechnique Fédérale de Lausanne
16+
identifiers:
17+
- type: doi
18+
value: 10.5281/zenodo.13862314
19+
description: DOI of the record on Zenodo. Valid for all versions.
20+
- type: doi
21+
value: 10.5281/zenodo.13862315
22+
description: DOI of version 3.0.0
23+
- type: url
24+
value: >-
25+
https://github.com/graasp/graasp-app-collaborative-ideation
26+
description: Repository
27+
repository-code: >-
28+
https://github.com/graasp/graasp-app-collaborative-ideation
29+
abstract: >-
30+
The Collaborative Ideation app in Graasp was made to
31+
organize blended and online activities where participants
32+
can share their inputs and react on them in real time.
33+
This app was designed and implemented inside the Graasp
34+
platform and is not independent from it.
1235
keywords:
1336
- creativity
1437
- ideation
1538
- collaboration
39+
- learning
40+
- education
41+
- blended
42+
- hybrid
43+
license: AGPL-3.0-only
44+
commit: ea9f04805d47f6cfe49a74280e504f3331db99c7
45+
version: 3.0.0
46+
date-released: '2024-09-30'

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
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)
53
![GitHub release (with filter)](https://img.shields.io/github/v/release/graasp/graasp-app-collaborative-ideation)
4+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13862315.svg)](https://doi.org/10.5281/zenodo.13862315)
65

76
[![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)
87
[![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)
@@ -15,26 +14,35 @@
1514
[![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)
1615

1716
![typescript version](https://img.shields.io/github/package-json/dependency-version/graasp/graasp-app-collaborative-ideation/typescript)
17+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
18+
19+
## About
20+
21+
The **Collaborative Ideation** app in Graasp was made to organize 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 independent from it.
22+
23+
### Citation
24+
25+
If you use this software or take inspiration from it, please, cite it as below:
1826

19-
# About
27+
> La Scala, J. (2024). Collaborative Ideation (v3.0.0). Zenodo. https://doi.org/10.5281/zenodo.13862315
2028
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.
29+
For citing the latest version, use the permanent DOI: [10.5281/zenodo.13862314](https://doi.org/10.5281/zenodo.13862314)
2230

23-
## Related publications
31+
### Related publications
2432

2533
This app was presented or used in the following publications:
2634

2735
- (_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
2836

29-
# Development
37+
## Development
3038

3139
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/).
3240

33-
## Installation
41+
### Installation
3442

3543
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).
3644

37-
## Running the app
45+
### Running the app
3846

3947
Create a `.env.development` file with the following content:
4048

@@ -51,7 +59,7 @@ To serve the app with the _full Graasp stack_, use `yarn dev`. If you want to tr
5159

5260
> ⚠️ 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.
5361
54-
## Running the tests
62+
### Running the tests
5563

5664
Create a `.env.test` file with the following content:
5765

@@ -66,6 +74,6 @@ VITE_VERSION=latest
6674
BROWSER=none
6775
```
6876

69-
# Contributors
77+
## Contributors
7078

7179
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)