Supabase is installed as a dependency and can be used with npx on all platforms.
Does not require any other installs (with brew or similar).
Updates the dependency to a newer version (1.176.10).
Files changed
.github/BEFORE_YOUR_FIRST_ISSUE.md with all the doc updates.
package.json with the version update.
The supabase scripts require no changes. npm uses locally installed binaries when running scripts (reference).
package-lock.json is automatically updated after a clean npm i (using npm10.7.0).
Changes to Documentation
Unifies and simplifies the existing documentation as there is no longer need for:
Installation of the supabase CLI.
UNIX/Windows specific commands.
Tests
Manual tests were performed for different scenarios that are possible after this PR is merged (assumes that npm install is executed beforehand).
Supabase and app are started and work as expected:
Without any previous data.
Will be the case for fresh checkouts of the repository.
Validated successfully.
With existing data, created by a previous supabase instance, installed separately with brew.
Will be the case for the current contributors using macOS/Linux.
Validated successfully. (in my case the version difference was between 1.167.4 and 1.176.10)
With existing data, created by a previous supabase instance, installed separately with npm.
Will be the case for the current contributors using Windows.
Validated successfully. (in my case the version difference was between 1.172.2 and 1.176.10)
Post-merge instructions
Pull the new changes.
Install dependencies with npm install.
Verify that the supabase CLI is on version 1.176.10 or newer, with npx supabase -v.
If it isn't, try removing the node_modules directory (rm -rf node_modules) and install the dependencies again.
Start supabase with npx supabase start.
If there are issues, it's possible that the existing data is causing problems. Go to Docker Desktop > Dashboard > Volumes > Find and Delete all supabase_* volumes and try starting supabase again. Note: Be mindful that this will DELETE all data that you might have added locally (users, items, conversations, etc.). Use with care.
After this PR is merged and the dependencies are freshly installed, it would be also a good idea to remove other globally installed supabase CLIs, avoiding possible mistakes.
Description
Closes #216
npx
on all platforms.brew
or similar).1.176.10
).Files changed
.github/BEFORE_YOUR_FIRST_ISSUE.md
with all the doc updates.package.json
with the version update.supabase
scripts require no changes.npm
uses locally installed binaries when running scripts (reference).package-lock.json
is automatically updated after a cleannpm i
(usingnpm
10.7.0
).Changes to Documentation
Unifies and simplifies the existing documentation as there is no longer need for:
supabase
CLI.Tests
Manual tests were performed for different scenarios that are possible after this PR is merged (assumes that
npm install
is executed beforehand). Supabase and app are started and work as expected:supabase
instance, installed separately withbrew
.1.167.4
and1.176.10
)supabase
instance, installed separately withnpm
.1.172.2
and1.176.10
)Post-merge instructions
npm install
.supabase
CLI is on version1.176.10
or newer, withnpx supabase -v
.node_modules
directory (rm -rf node_modules
) and install the dependencies again.npx supabase start
.supabase_*
volumes and try starting supabase again. Note: Be mindful that this will DELETE all data that you might have added locally (users, items, conversations, etc.). Use with care.After this PR is merged and the dependencies are freshly installed, it would be also a good idea to remove other globally installed
supabase
CLIs, avoiding possible mistakes.