This is a Next.js project that reads in Markdown files from a given folder and uses the markmap library to visualize it as a mind map. The use case is to visualize the structure of your organization.d
A demo can be found here
- Node.js (version 14 or later)
- Yarn (or npm)
- Clone this repository to your local machine.
- Run
yarn
install to install the dependencies.
- Add the desired structure to the file
./map/org.md
, using Markdown syntax. - run
yarn dev
to test the project on localhost - Via regex the amount of people and different professions (in our case it is Product, Data Science, developers, working students and externals) is counted and visualized - to change them (can be found in
./utils/stringUtils.ts
) you also need to refactor the corresponding tests. The following list shows you the patterns how the different professions are labeled- Product -
(P)
- Working Student -
(WS)
- Data Scientists -
(DS)
- Developers -
(Dev)
- Externals -
(F)
- Product -
- Commit and push the changes to your repository.
- A GitHub Action will run and generate a new version in the history mind maps (stored in the
_maps
folder) - deploy the project to what ever provider that you want to use - in this case it is deployed to vercel
- Next.js
- Markmap
- Jest
- Tailwind
This project is licensed under the MIT License - see the LICENSE.md file for details.