Getting Started
Let's get started with a new OneStarter project in 3 minutes!
Download & Setup
You should have received a link to download your OneStarter kit with your purchase. If you have any difficulty accessing it, please reach out directly to [email protected].
What you'll need
Linux or macOS are strongly recommended. Windows is only supported with WSL2.
Running locally
To start, you can rename the default placeholders to your project's name. You can do this by running the following command:
cd directory-of-project
./setup.sh
# this will prompt you to enter your app name and domain of your project
# afterwards, it will try to start up Supabase, and
# copy and paste the placeholder environment files in the right places
To run the project locally, you need the following running:
- Supabase
- Backend
- Frontend
You can develop with the reverse proxy locally, as well, but it is not necessary.
Let's start each of these up:
# from the root of your project
# start Supabase
# Note: this may already be running if you ran ./setup.sh earlier, but it won't hurt if you do it again
cd db
just up
# start the backend
cd ../backend
bun run dev
# in a second terminal, start the frontend
cd frontend
bun run dev
Now you can find your project running at http://localhost:3000.
That's all you need! 🚀