sgerp-frontend-lib
v0.2.8
Published
TypeScript/React library for interacting with the SGERP API, providing client SDK, Backbone.js-style Collections, and pre-built React components
Maintainers
Readme
SGERP Frontend Library
TypeScript/React library for interacting with the SGERP API. Provides a client SDK, Backbone.js-style Collections with reactive hooks, and pre-built React components.
Installation Methods
Method 1: NPM Package (Traditional)
npm install sgerp-frontend-libMethod 2: shadcn CLI (Copy & Own the Code)
Install the complete library directly into your project:
npx shadcn@latest add https://sgerp-frontend-lib.vercel.app/registry/lib/sgerp-libThis copies all sgerplib/sgerp files into your project. You own the code and can modify it as needed.
Dependencies installed:
underscorereactdate-fns@types/underscore(dev)
What gets installed:
- Complete SGERP API client (
sgerplib/sgerp/) - All collections (User, Project, Vehicle, etc.)
- React hooks (
useSGERP,useCollection) - TypeScript types
- Localization system (English, Japanese, Malay)
- Connection manager
Getting Started
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Vercel
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
