spa-apiscoringviewer

SPA API Scoring

The SPA that displays what is wrong in your API and leads you to where you can fix it.

Learn more in the doc!

This folder contains the SPA of the API Scoring extension. The structure is the following:

└─ spa-apiscoringviewer/
   └─ packages/
      └─ apiscoringviewer/
         └─ src/
            └─ certification/
            └─ components/
            └─ files/
            └─ hooks/
            └─ locales/
            └─ utils/
      └─ spa-apiscoringviewer/
         └─ src/
            └─ components/

How to run the SPA

1. Clone the repository:

   git clone [email protected]:InditexTech/api-scoring-ide-plugins.git
   

2. Place yourself in the correct directory:

   cd plugins/spa-apiscoringviewer
   

3. Install the dependencies:

   pnpm i
   

4. Once the process finishes, start the SPA:

   pnpm --filter apiscoringviewer watch
   pnpm --filter spa-apiscoringviewer watch
   

5. If you are executing it on local, open VSCode with the plugin already installed. In the plugin configuration (Api Scoring › Certification › Frontend: Url) set the frontend URL to:

http://localhost:3000

Usage

View the documentation for usage information.