luis-saes/generic-dashboard

Open-source generic dashboard.

EN | PT

Generic Dashboard

Just a Generic Dashboard

About The Project

This Dashboard was created with the purpose of getting knowledge in different web development abilities. You can check the design through the link: https://www.figma.com/file/WFyRPMM0S1pHvFf4vN5vl6/Generic-Dashboard

Built With

• 
• 
• 
• 

Installation

To get a copy of the dashboard code on your machine, just clone the repository with the following command:

$ git clone https://github.com/luis-saes/portfolio-dashboard.git

How to Contribute

1. Choose an issue from the repository and leave a comment showing interest in solving it.
2. Install the project on your machine
3. Fork the repository, create a new branch and develop the work requested in the issue, utilizing the correct file to make the changes, as specified in the chosen issue
4. When the work is finished, submit a Pull Request whose message body must comply with the following template:

Description: Provide a brief description of the work performed.
<BLANK LINE>
Fixes #<ISSUE NUMBER THAT WAS SOLVED>

Getting Started

WIP

Prerequisites

Node version 16.16.0 or later. NPM version 8.13.2 or later.

Usage

1. Install the project on your machine.
2. Run the React front-end by accessing the folder /front-end and running the terminal command npm start.
3. Access localhost:3000/login for the login screen and localhost:3000/dashboard for the dashboard screen.

Roadmap

• Design dashboard pages with Figma
• Create React front-end structure
• Create Express back-end structure
• Create SQLite database structure
• Develop front-end placeholders
• Design SQLite tables
• Create and populate SQLite tables
• Create backend MVC
• Integrate front-end with back-end data
• Create login authentication
• Deploy application

License

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

Contact

Luis Henrique Saes Scandelai - saeslhs@gmail.com

Project Link: https://github.com/luis-saes/portfolio-dashboard