Table of Contents

1. Introduction
   • Requirements
   • Built With
   • Known Bugs
2. Installation
   • Development
3. FAQ
4. License
5. Contributors

Introduction

Mindmap is a web application that allows users to create mind maps and share them with other users. The application is built with React, TypeScript, Node.js, Express, PostgreSQL, Material-UI, Prisma ORM, Docker, Git and Github Actions.

(back to top)

Requirements

This project requires the following software:

• Docker
• Docker Compose

(back to top)

Built With

The app has been built with the following technologies:

• React
• TypeScript
• Node.js
• Express
• PostgreSQL
• Material-UI
• Prisma ORM
• Docker
• Git

(back to top)

Known bugs

• TBD

(back to top)

Installation

In order to install the project locally, you need to have Docker installed.

Development

1. Clone the repo

git clone https://github.com/GritzMaze/Mindmap.git

2. Configure the environment variables in the docker-compose.yml file or you can leave the default ones.

DATABASE_URL:
JWT_KEY:
JWT_EXPIRATION: 
APP_PORT: 
BCRYPT_SALT_ROUNDS:
LOG_LEVEL: 
LOG_OUTPUT:

POSTGRES_PASSWORD:
POSTGRES_USER:
POSTGRES_DB:

3. Compose the project

docker-compose up --build -d

(back to top)

FAQ

• How to run the tests?

  • Currently, only the server has tests. To run them, you need to go to the server directory and run the following command:

    npm run test

(back to top)

License

The project is distributed under MIT.
Description of the license can be found here.

(back to top)

Contributors

Kamelia Atanasova 💻

Martin Jivkov 💻

Mihaela Kolarova 💻

Vesselin Jivkov 💻

(back to top)