quickli
v1.0.0
Published
Easy-to-use Supabase client with automatic configuration and connection management
Maintainers
Readme
Supabase Easy Client
A simplified Supabase client with automatic configuration and connection management for Node.js applications.
Features
- 🔌 Automatic configuration from environment variables
- 🚀 Simple, intuitive API
- 💪 TypeScript support
- ✅ Connection testing utilities
- 🔒 Secure credential management
Installation
npm install supabase-easy-clientQuick Start
- Set up your environment variables:
SUPABASE_URL=your-project-url
SUPABASE_KEY=your-anon-key- Use the client:
const supabase = require('supabase-easy-client');
// Query your data
const { data, error } = await supabase
.from('users')
.select('*');Alternative Setup
You can also initialize the client explicitly:
const SupabaseClient = require('supabase-easy-client');
const supabase = new SupabaseClient(
'your-project-url',
'your-anon-key'
);API Reference
Querying Data
// Select data
const { data, error } = await supabase
.from('table')
.select('*');
// Insert data
const { data, error } = await supabase
.from('table')
.insert({ column: 'value' });
// Update data
const { data, error } = await supabase
.from('table')
.update({ column: 'new_value' })
.eq('id', 1);
// Delete data
const { data, error } = await supabase
.from('table')
.delete()
.eq('id', 1);Authentication
// Sign up
const { data, error } = await supabase.auth().signUp({
email: '[email protected]',
password: 'password123'
});
// Sign in
const { data, error } = await supabase.auth().signInWithPassword({
email: '[email protected]',
password: 'password123'
});
// Sign out
const { error } = await supabase.auth().signOut();Storage
// Upload file
const { data, error } = await supabase
.storage()
.from('bucket')
.upload('file.txt', fileBody);
// Download file
const { data, error } = await supabase
.storage()
.from('bucket')
.download('file.txt');Testing Connection
const supabase = require('supabase-easy-client');
try {
await supabase.testConnection();
console.log('Connected to Supabase!');
} catch (error) {
console.error('Connection failed:', error.message);
}Environment Variables
Required environment variables:
SUPABASE_URL: Your Supabase project URLSUPABASE_KEY: Your Supabase anon key or service role key
TypeScript Support
Types are included and will work automatically with TypeScript projects.
Troubleshooting
Common Issues
"Supabase credentials not found"
- Ensure environment variables are set correctly
- Check for typos in variable names
- Verify credentials are valid
"Connection failed"
- Check internet connection
- Verify Supabase project is active
- Confirm API credentials are correct
License
MIT
