Overview:

This product is a ready-to-use template for quick start with React, a popular JavaScript library for building user interfaces. The template provides a variety of features and options to customize the look and functionality of the application. It includes support for dark mode, different template colors, various header types, scroll to top functionality, progressive web app (PWA) features, and different authentication, database, and API types. It also includes tools for testing, editing, and running the application. The template can be easily installed and customized to suit the needs of different projects.

Features:

• Dark Mode: Toggle between dark and light mode.
• Template Color: Choose from a variety of colors for the template.
• Header Types: Select from different options for the header, such as static, fixed, hide, or elevate.
• Scroll to Top: Automatically scroll to the top of the page.
• PWA: Enable progressive web app features.
• Authentication Types: Choose from various authentication methods, including web3, OAuth, email, or mobile.
• Database Types: Select the desired database type, such as MongoDB, MariaDB, or PostgreSQL.
• API Types: Choose between REST or GraphQL for the API.
• Mock Server (Mock API): Simulate API responses for testing or development purposes.
• Prometheus (Metrics): Collect and analyze metrics for monitoring the application.
• Test (Mocha, Chai, Jest): Includes testing tools for automated testing of the application.

Installation:

To install the template, follow these steps:

1. Clone the project.
2. Edit the Home.js and Page1.js files in the Client\src\Content\Screens directory, or add other pages as needed.
3. Modify the name of your pages in the following files:
   • Main.js in the Client\src\Content directory for routing.
   • ListItems.js in the Client\src\Content\Header\Drawer directory for showing in the menu.
4. Modify the values in the .env file according to your needs.
5. To run the frontend:
   • Open the terminal in the client directory.
   • Run the command npm start.
   • Open http://localhost:3000 in your browser to view the application.
6. To run the backend (real server):
   • Edit the .env file in the client directory and set PROMATHEUS="false".
   • Open the terminal in the server directory.
   • Run the command npm start.
   • Open http://localhost:4000 in your browser to view the application with active Prometheus metrics.
   • To enable Prometheus metrics, first run PLG docker compose: PLG.

Summary:

This product is a ready template for a quick start with React. It provides a wide range of features and options to customize the application, including dark mode, different template colors, header types, scroll to top, PWA support, and various authentication, database, and API types. The template also includes tools for testing, editing, and running the application. It can be easily installed by cloning the project and following the provided instructions. Overall, this template offers a convenient and efficient way to start a React project and customize it according to specific requirements.