skillup-firebase-client-utils-v2
v1.2.9
Published
Firebase client SDK utils for skillup's firebase
Maintainers
Readme
Skillup Firebase Client Utils V2
Firebase client SDK utilities for Skillup's Firebase implementation. This package provides a set of tools and utilities for handling Firebase operations in Skillup's web applications.
Features
- 🔥 Firebase configuration management
- 👤 Profile management
- 💝 Donation handling
- 🤝 Partnership management
- 📋 Shaper position management
- 📝 Shaper registrant handling
- ⚡ Core utilities and base services
- 🛡️ Built-in validation and sanitization
- 🔍 Error handling and type safety
Installation
npm install skillup-firebase-client-utils-v2Project Structure
src/
├── config/ # Firebase configuration
├── core/ # Base interfaces and services
├── features/ # Feature modules
└── utils/ # Utility functionsUsage
import {
FirebaseConfig,
ProfileService,
} from 'skillup-firebase-client-utils-v2';
// Initialize Firebase configuration
const firebaseConfig = new FirebaseConfig({
// Your Firebase config options
});
// Use profile service
const profileService = new ProfileService();
await profileService.create({
// Profile data
});Available Services
Profile Management
- Create, read, update, and delete user profiles
- Profile validation and error handling
Donation Management
- Process and manage donations
- Donation validation and error tracking
Partnership Management
- Handle partnership operations
- Partnership validation
Shaper Position Management
- Manage position listings
- Position validation and updates
Shaper Registrant Management
- Handle registrant applications
- Registrant validation and processing
Development
# Install dependencies
npm install
# Build the project
npm run build
# Run tests
npm test
# Run linting
npm run lint
# Format code
npm run format
# Generate documentation
npm run docsDocumentation
Full documentation is available at https://docs.skill-up.id/. The documentation includes:
- API Reference
- Type Definitions
- Usage Examples
- Feature Guides
License
ISC License - see the LICENSE file for details.
