TPA Designer is a web application that allows the user to create and edit Team Practices Agreements (TPAs) for the Governify framework. It has been developed using Vue.js 3, Vite and PrimeVue.

• Project setup
• Documentation
  • Vue.js 3
  • Vite
  • PrimeVue
  • SimpleCodeEditor
• Governify specific configuration
• Contributing
• Authors
• License
• Badges

npm install

npm run dev

npm run build

The documentation for Vue.js 3 can be found under the following link.

The documentation for Vite can be found under the following link.

The documentation for PrimeVue can be found under the following link.

The Code Editor component used for editing JSON, JavaScript and GraphQL is SimpleCodeEditor and its documentation can be found under the following link.

This application has been developed to be used within the Governify framework. In order to do so, some Governify-specific tool like Bluejay must be deployed in the same server as the TPA Designer.

The following table shows the tools that must be deployed and the corresponding environment variables that must be set in the TPA Designer.

There are two ways to set the environment variables:

1. Create a .env file in the root directory of the project and set the variables there. The file should look like this (the values are just examples):

ASSETS_MANAGER_URL=https://assets.bluejay.governify.io/
REGISTRY_URL=https://registry.bluejay.governify.io/
SCOPE_MANAGER_URL=https://scopes.bluejay.governify.io
COLLECTOR_EVENTS_URL=https://event-collector.bluejay.governify.io/

2. Set the environment variables in the server where the TPA Designer is deployed.

In the /src/stores/tpaEdition.js file, there are some variables that hold the enumerated values for the different options that can be selected in the edition mode of the app. These variables are used to populate the dropdowns in the TPA Designer, among other things. The values of these variables can be modified to add new types to the dropdowns. The variables are:

• BLOCK_TYPES
• COLLECTOR_EVENT_SOURCES
• COLLECTOR_EVENT_ENDPOINTS
• STEP_TYPES
• WINDOW_PERIOD_OPTIONS

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

• Mariano Manuel Torrado Sánchez - MaToSan24

This project is licensed under the MIT License - see the LICENSE file for details.