Skip to content

Commit

Permalink
improved readme e.g. with image (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
JannikStreek authored Oct 3, 2022
1 parent 7488601 commit fc63c88
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Mindmapping made simple: Host and create your own mindmaps. Share your mindmap s

TeamMapper is based on mindmapp (https://github.com/cedoor/mindmapp , discontinued). In contrast to mindmapp, TeamMapper features shared mindmapping sessions for your team based on websockets.

![TeamMapper Screenshot](docs/teammapper-screenshot.png?raw=true "TeamMapper Screenshot with two users")

## Features:

- Host and create your own mindmaps
- Set node images, colors and font properties.
- Shortcuts
- Import and export functionality (JSON, PDF, PNG...)
- Import and export functionality (JSON, SVG, PDF, PNG...)
- Mutli user support: Share your mindmap with friends and collegues. Work at the same time on the same mindmap!
- Use a QR Code or URL to share your maps
- By default, mindmaps are deleted after 30 days to ensure GDPR compliancy.

## Getting started
Expand All @@ -26,15 +29,13 @@ TeamMapper is based on mindmapp (https://github.com/cedoor/mindmapp , discontinu
- Start frontend and backend at once

```bash
docker-compose exec app sh
# Inside docker container, you execute the following
npm --prefix teammapper-backend run dev
docker-compose exec app npm --prefix teammapper-backend run dev
```

or start frontend and backend separately

```bash
# Open to terminal session on your host machine
# Open two terminal sessions on your host machine
# In first terminal session
docker-compose exec app npm --prefix teammapper-backend start
Expand Down Expand Up @@ -125,7 +126,7 @@ docker-compose --file docker-compose-prod.yml --env-file .env.prod exec app_prod
Example of running sql via typeorm:

```
npx typeorm query "select * from mmp_node" --config dist/ormconfig.js
docker-compose --file docker-compose-prod.yml --env-file .env.prod exec app_prod npx --prefix teammapper-backend typeorm query "select * from mmp_node" --config dist/ormconfig.js
```

### Further details
Expand Down
1 change: 1 addition & 0 deletions docker-compose-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ services:
image: postgres:12-alpine
# Pass config parameters to the postgres server.
# Find more information below when you need to generate the ssl-relevant file your self
# In case you dont plan to use a certificate, uncomment this line
command: -c ssl=on -c ssl_cert_file=/var/lib/postgresql/server.crt -c ssl_key_file=/var/lib/postgresql/server.key
environment:
PGDATA: /var/lib/postgresql/data/pgdata
Expand Down
Binary file added docs/teammapper-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fc63c88

Please sign in to comment.