Documentation

Welcome to the documentation for our project's style guide! The style guide provides a set of predefined styles that can be used consistently throughout the entire project. It serves as a reference for developers, ensuring consistent and cohesive styling across different components and pages.

Once the style guide is integrated into your project, you can start utilizing the predefined styles. Apply the styles to your components by referencing the appropriate class names or style variables provided by the style guide.

Prerequisites

To get started with the project, follow these steps:

1. Install the necessary dependencies and set up the development environment. Refer to the single-spa documentation for detailed instructions.
2. Configure the project's root application by following the guidelines provided in the single-spa configuration documentation if needed, the project is already configured, so at the moment the documentation will be just to check if everything is as it needs to be. This will define the structure and behavior of your microfrontend project.
3. Integrate your React components into the project's root application. The single-spa framework allows you to selectively render components based on the specified routes and conditions.

Setting Up a Project

Install NodeJS and NPM:

1. Windows

cinst nodejs.install

2. MacOS

brew install node

3. Linux

Check the docs

Installation

1. Clone the repo

   git clone https://gitlab.devops.spms.min-saude.pt/design-system/styleguide.git

2. Install NPM packages

   npm install --legacy-peer-deps

3. Run the code

   npm start