autogen/python/packages/autogen-studio/frontend
Jack Gerrits 2596648fc9 move studio to a package 2024-09-30 10:20:38 -04:00
..
src move studio to a package 2024-09-30 10:20:38 -04:00
static/images/svgs move studio to a package 2024-09-30 10:20:38 -04:00
.env.default move studio to a package 2024-09-30 10:20:38 -04:00
.gitignore move studio to a package 2024-09-30 10:20:38 -04:00
LICENSE move studio to a package 2024-09-30 10:20:38 -04:00
README.md move studio to a package 2024-09-30 10:20:38 -04:00
gatsby-browser.js move studio to a package 2024-09-30 10:20:38 -04:00
gatsby-config.ts move studio to a package 2024-09-30 10:20:38 -04:00
gatsby-ssr.tsx move studio to a package 2024-09-30 10:20:38 -04:00
package.json move studio to a package 2024-09-30 10:20:38 -04:00
postcss.config.js move studio to a package 2024-09-30 10:20:38 -04:00
tailwind.config.js move studio to a package 2024-09-30 10:20:38 -04:00
tsconfig.json move studio to a package 2024-09-30 10:20:38 -04:00

README.md

🚀 Running UI in Dev Mode

Run the UI in dev mode (make changes and see them reflected in the browser with hotreloading):

  • npm install
  • npm run start

This should start the server on port 8000.

Design Elements

Modifying the UI, Adding Pages

The core of the app can be found in the src folder. To add pages, add a new folder in src/pages and add a index.js file. This will be the entry point for the page. For example to add a route in the app like /about, add a folder about in src/pages and add a index.tsx file. You can follow the content style in src/pages/index.tsx to add content to the page.

Core logic for each component should be written in the src/components folder and then imported in pages as needed.

connecting to front end

the front end makes request to the backend api and expects it at /api on localhost port 8081

setting env variables for the UI

  • please look at .env.default
  • make a copy of this file and name it .env.development
  • set the values for the variables in this file
    • The main variable here is GATSBY_API_URL which should be set to http://localhost:8081/api for local development. This tells the UI where to make requests to the backend.