@rootaccessd/client 1.0.5

package/README.md

@@ -0,0 +1,47 @@
+# @rootaccessd/client
+
+TypeScript/Axios API client for any RootAccess-compatible CTF backend, auto-generated
+from the OpenAPI spec.
+
+## Installation
+
+```bash
+npm install @rootaccessd/client axios
+```
+
+## Quick Start
+
+```typescript
+import { AuthApi, ChallengesApi, Configuration } from '@rootaccessd/client';
+
+// 1. Point at your backend
+const baseConfig = new Configuration({ basePath: 'http://localhost:8080' });
+
+// 2. Login and extract token
+const authApi = new AuthApi(baseConfig);
+const { data } = await authApi.authLoginPost({ username: 'you', password: 'secret' });
+const token = data.token;
+
+// 3. Use Bearer auth for protected endpoints
+const authedConfig = new Configuration({
+  basePath: 'http://localhost:8080',
+  apiKey: () => `Bearer ${token}`,
+});
+
+const challengesApi = new ChallengesApi(authedConfig);
+const challenges = await challengesApi.challengesGet();
+```
+
+## Using the RootAccess Angular Frontend
+
+Clone the repo and set your backend URL in
+`frontend/src/environments/environment.ts`:
+
+```ts
+export const environment = {
+  apiUrl: 'http://your-backend:8080',
+  wsUrl:  'ws://your-backend:8080',
+};
+```
+
+Then `npm start` — it talks to your backend automatically.