Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gerdesque authored Oct 20, 2023
1 parent 6bd64b8 commit 20a5d8c
Showing 1 changed file with 56 additions and 6 deletions.
62 changes: 56 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Plantala
<p align="center">
<a href="https://digitalwarenkombinat.github.io/plantala/">
<img alt="Logo of 'Plantala'" src="public/icon-192.png">
</a>
</p>

![Screenshot of the Mainpage of Plantala](https://www.plantala.de/images/plants/start.webp)
---

[![Screenshot of _Plantala_](plantala.png)](https://digitalwarenkombinat.github.io/plantala/)

## About [_Plantala_](https://digitalwarenkombinat.github.io/plantala/)

The **Plantala** web application was created as a prototype as part of the Coding da Vinci Niedersachsen 2020 cultural hackathon and was renewed and further developed during a three-month grant.

Expand All @@ -12,13 +20,55 @@ The images are based on plant elements from botanical teaching posters, which th

All black and white vector graphics and plantalas created are freely licensed and can be used in a variety of ways, e.g. for lessons, for environmental education offers or simply for private decoration.


_**Plantala's** source code runs under an MIT license. Some of the digital copies of botanical teaching posters provided by the University of Göttingen were published under a CC BY-SA 4.0 license. The teaching charts that previously appeared in published works run under a Public Domain Mark 1.0 and are therefore in the public domain. This also applies to the colorful plant cuttings. All black and white plant vectors created specifically for the project run under a CC BY-SA 4.0 license._


### MaaS (Media station as a Service)

Furthermore within the project developed the idea of **Media station as a Service (MaaS)**,
which allows easily to reuse the framework of the **Plantala** project to create new, simple Mandala generators and to use them as media station for example in museums, galleries or educational centers.
Furthermore within the project developed the idea of **Media station as a Service (MaaS)**, which allows easily to reuse the framework of the **Plantala** project to create new, simple Mandala generators and to use them as media station for example in museums, galleries or educational centers.

## [Create your own media station!](./medienstationAsAService/README.md)

## Feedback

Feel free to send us feedback on [Twitter](https://twitter.com/digiwako) or [file an issue](https://github.com/digitalwarenkombinat/plantala/issues/new). Feature requests are always welcome.

## Getting started

Run the following command on your local environment:

```
git clone --depth=1 https://github.com/digitalwarenkombinat/plantala.git
cd plantala
npm install
```

You can run the application in development mode with live reload:

```
npm run dev
```

Open http://localhost:3000 with your favorite browser to see the application.

```
.
├── README.md # README file
├── next.config.js # Next JS configuration
├── public # Public folder
│ └── images # Images used by the application
├── components
│ ├── ui # Visual components
│ └── utils # Utility folder
├── pages # Next JS pages
└── tsconfig.json # TypeScript configuration
```

You can see the results locally in production mode with:

```
npm run build
npm run start
```

[Create your own media station!](./medienstationAsAService/README.md)
The generated HTML and CSS files are minified (built-in feature from Next js).

0 comments on commit 20a5d8c

Please sign in to comment.