Front-End Starter Template

This repository is a front-end starter template using MUI, React, and TypeScript. It is designed to help you quickly set up a new project with the best practices and configurations already in place.

Getting Started

Usage

This repository is already set up to connect to the Plutus High Assurance Project Board. To make sure you have this fully set up properly complete the following steps every time you use this template.

1. Click on the Use this template button on the GitHub repository page.
2. Fill in the repository details to create your new project repository.
3. Once instantiated, ensure that you have the following labels in your repository:
   • epic
   • story
   • task
   • bug
   • idea
   • to be triaged

Running the Application

To get the application running, follow these steps:

1. Clone your newly created repository:

   git clone https://github.com/yourusername/yourrepository.git

2. Navigate to the starter_app folder:

   cd yourrepository/starter_app

3. Install the necessary packages:

   npm install

4. Start the application:

   npm run start

Project Structure

The template is organized as follows:

• github: Contains a workflow to sync this repo with updates made on parent repo Plutus-High-Assurance-Template.
• starter_app: The main application directory.
  • public: Contains public assets like HTML and images.
  • src: Contains the main source code for the application.
    • components: Reusable React components.
    • styles: Global styles and theme configuration.

Customization

This template is designed to be easily customizable. Feel free to modify the files and structures to suit your project's needs. The template uses MUI for UI components and theming, and it is set up to use TypeScript for type safety and development efficiency.

Contributing

If you have any suggestions or improvements, feel free to open an issue or create a pull request. Contributions are always welcome!