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 6894fcb commit 2f142d1
Showing 1 changed file with 58 additions and 2 deletions.
60 changes: 58 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# [PROTESTORY!](https://www.protestory.de/)
<p align="center">
<a href="https://www.protestory.de/">
<img alt="Logo of 'PROTESTORY!'" src="public/icon-192.png">
</a>
</p>

![PROTESTORY!](http://protestory.de/image_bg.png)
---

[![Screenshot of _PROTESTORY!_](protestory.png)](https://www.protestory.de/)

## About [_PROTESTORY!_](https://www.protestory.de/)

**PROTESTORY!** is a web application that offers a playful exploration of protest cultures of working-class youth from the early 20th century until today.

Expand All @@ -16,3 +24,51 @@ The project **PROTESTORY!** has been developed as part of "dive in. Programme fo
The digital items were taken from the collection of the Archive of the Workers´ Youth Movement, which made them available to us.

_The source code runs under an MIT license. The free font "Hey August" used for the titles is by Syafrizal a.k.a. Khurasan (dafont.com). The font "Fabrik" used for the body texts is by Peter Wiegel (peter-wiegel.de). Furthermore the phone noise is from the sound "Phone Dialing With Dialtone" by KevanGC (soundbible.com) and runs under a public domain._

## Feedback

Feel free to send us feedback on [Twitter](https://twitter.com/digiwako) or [file an issue](https://github.com/digitalwarenkombinat/protestory/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/protestory.git
cd protestory
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 for assets and logo
├── src
│ ├── components # UI components
│ ├── config # Mini game configurations
│ ├── context # Shared enums
│ ├── pages # Next.js pages
│ ├── services # Mini game services
│ ├── styles # Global stylesheets
│ └── 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
```

The generated HTML and CSS files are minified (built-in feature from Next js).

0 comments on commit 2f142d1

Please sign in to comment.