Laméco Dashboard System by De Sigaar

Table of Contents

• About
• Prerequisites
• Installation
  • Clone
  • Setup
  • Running
• API documentation
• Built with
• Creators

About

This project was made by some students from the Fontys Hogeschool ICT on behalf of Laméco.
A live preview can be found on our deployed heroku app.

Prerequisites

• Node.js

Installation

Make sure you have Node.js installed. If you are unsure if node is installed, run $ node -v within terminal/command prompt.

Clone

Clone this repository to your local machine and move to the new folder.

$ git clone https://github.com/de-sigaar/LamecoDashboard.git
$ cd LamecoDashboard

Setup

Install all needed node modules for both frontend and backend.

$ npm run install-all

Running

For the application to be able to function as normal, it needs to run both the frontend and backend.

$ npm run dev

This starts the backend on port 5000 and the frontend on port 3000 concurrently.

API documentation

The API documentation for the API used within the application can be found in our Postman collection.

Built with

Most important stuff

• MongoDB
• Express
• React
• Redux
• Node.js
• SASS

Additional stuff

• Gravatar
• React-Grid-Layout
• React-Copy-To-Clipboard
• React-Select
• React-Live-Clock

Creators

• Max Altena - GitHub
• Dylano Hartman - GitHub
• Mark Hendriks - GitHub
• Mike Hendriks - GitHub
• Bart van de Klundert - GitHub

See the whole list of contributors who participated in this project.