@vtex/raccoon-proxy
v1.0.0
Published
On this package you will find the implementation of the Raccoon Proxy, which is a server that acts as a middleman between the Next.js application requests and VTEX IO services, on the Admin. The Raccoon Proxy is responsible for handling the communication
Downloads
883
Maintainers
Keywords
Readme
@vtex/raccoon-proxy
On this package you will find the implementation of the Raccoon Proxy, which is a server that acts as a middleman between the Next.js application requests and VTEX IO services, on the Admin. The Raccoon Proxy is responsible for handling the communication between the Next.js applications and VTEX IO services.
To learn more about this package, read our internal documentation at: https://admin-platform.vtex.com/raccoon/api-reference/raccoon-proxy.
Development guidelines
While making changes to this package you want to see them reflected upon real applications. For this reason, to develop @vtex/raccoon-proxy you will use one, or all the examples available on the examples
folder to test the changes you make.
Below you will find a list of commands that streamline the development process for each use case:
# Builds all raccoon packages in parallel > builds all examples in parallel > watches for
# changes in all raccoon packages and starts the development server for the examples
# all in parallel. This is the most convenient command to test raccoon applications.
# This command doesn't link the examples to VTEX.
pnpm run dev:raccoon-examples
# This command links the examples to VTEX
pnpm run dev:raccoon-examples:link
Contributing
If you found a way of improving this package, please open a pull request or issue and we will be happy to review it.