Download pocketbase runtime depending on your OS.
paste it on the pb
directory;
You don't need to touch that directory.
After downloading try running pnpm run dev:api
If successful initialize your instance by going at http://localhost:8090/_/
Copy the .env.example
to .env.development
cp .env.example .env.development
Whatever you put in the installer setup should also be in your
.env.development
credentials
Use the sample data just upload the sampledata.zip
located at
pb
directory to your local pb instance at Backups
You local data that you have will stay with you as pb/pb_data
is gitignored
This will keep our production data pristine
You can now install node dependencies using pnpm install
On a seperate terminal run the ff commands on each one
pnpm dev:api
and pnpm dev:web
In case you are lazy run both using pnpm dev
but some systems
might not support closing each child process.
Contribute and make a PR.
For further questions reachout with the team
The following project will only be deployable using adapter-node
and all other env
setup is there.
If you want to deploy a similar stack on your own you need to host your own pb instance.
Go to your PocketBase http://localhost:8090
At the left side Select Collection > "users" collection
Click Gear Icon "edit collection"
Select "Options" and click drop down "OAuth2"
Click "Enable" then click "Manage OAuth2 providers"
A new tab will open showing all available OAuth2 providers in pocketbase.
Select the provider you need.
Enable it then add credentials needed. Google, Discord and GitHub providers require Client ID and Client Secret.
Here are some guides in creating an OAuth app per provider.
Please follow the link for instructions and guidelines on how to create an app on GitHub https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app
Please follow the link for instructions and guidelines on how to create an app on Google. https://support.google.com/cloud/answer/6158849?hl=en