If you don't want to use the Superagent Cloud you can optionally run Superagent localy. In order to make Superagent more modular we have decoupled the Superagent API from the Superagent UI. You can run the API directly by just leveraging the SDKs. Follow the guides below to get started.
Setup Superagent API
Clone the Superagent repository and open the superagent folder.
libs/superagentand copy the
.env.exampleto a new file named
In order to get Superagent running we need to set some mandatory environment variables. Here is an example:
Create a virtual env
In the console, create a virtual environment to install and run the python api.
Then activate the new virtual environment to work in it.
Use poetry to install the project dependencies in the virtual environment
Get Supabase Info
Get the hostname and port of your Supabase instance and replace them in the
DATABASE_MIGRATION_URL variable in your
Run database migrations
Start the server
Use local API with the Superagent SDK
And that's it! You now have an instance of the Superagent API running on your local machine. Make sure to checkout the REST API reference for more details on each API endpoint or visit http://127.0.0.1:8000 to view the Swagger docs.
Setup Superagent UI
The Superagent UI is setup using Supabase. It leverages the Supabase's
Storage modules. Configure your Supabase setup as per the instructions below:
- Clone the Superagent repository
Install Supabase CLI and create project: https://supabase.com/docs/guides/cli/getting-started
Start the local Supabase project
- Run the database migrations
- Create a Supabase storage with the following
Superagent supports password-less authentication and Github OAuth. You may add which ever Authentication provider supported by Supabase.
Create a new Github OAuth app in your Github account
CLIENT_SECRETand paste them into the
/libs/ui/.envvariables in your local Superagent project.
Set the following callback URL
- Navigate to your Supabase project you have created for Superagent UI and paste the
NOTE: You can enable any provider using the steps above.
Change the name of
Set the required environment variables.
- From inside
- Start the app
You should now be able to visit http://localhost:3000 and see the Superagent login page