Mindmerge

View Demo

Mindmerge is a web application focused on optimizing workflow. The app allows users to create work schedules and tasks to assist businesses in dividing workloads. The flagship feature is the system - integrated with modern language models - that provides fully automated reports on personnel productivity, based on notes and comments provided by employees themselves in an easy and flexible manner.

For more information about the project, check out:

Deliverable 1

Deliverable 2

(back to top)

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

NodeJS is the only prerequisite required to test the platform

Our project structure is organized in 5 different submodules

• The main repository (this one) where we keep the readme, the UML documentation, and the sprints documentation
• The backend repository where we keep the code related to the backend
• The front end repository where we keep the code related to the front end
• The common infrastructure repository where we keep data structures that are used both in the backend and in the frontend
• The app repository that is used to host the frontend using GitHub pages

1. Clone the repo and inizialize the submodules:

   git clone https://github.com/github_username/repo_name.git &&
   cd Mindmerge &&
   git submodule update --init --recursive

2. Install NPM packages both in backend and frontend:

   (cd backend/ && npm install .) &
   (cd frontend/ && npm install . && npm run convert) &

(back to top)

From the main folder Mindmerge, launch the following command on the shell to start both the frontend and the backend:

(cd backend/ && npm run dev) & (cd front_end/ && npm run dev) &

Here is a brief list of the command available via npm run:

Frontend

• npm run test:
  Launch the automated tests via Jest
• npm run dev:
  Launch the application for development purpose
• npm run generate-api:
  Generates the internal API documentation, based on the JSdoc comments within the files
• npm run documentation:
  Generates the automated documentation

Backend

• npm run convert:
  Required to convert the syntax from common js to ES6
• npm run dev:
  Same as the backend counterpart
• npm run preview:
  Starts the application and automatically launches the browser on the starting page

(back to top)

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)