b3-api

> Main B3 API

About

This project uses Feathers. An open source framework for building APIs and real-time applications.

Getting Started

1. Make sure you have NodeJS and npm installed.
2. Install your dependencies

``
cd path/to/b3-api
npm install
`

3. Start your app

`
npm run build # Compile TypeScript source
npm start
`

Testing

Run npm test and all your tests in the test/ directory will be run.

API Testing with Postman

This project includes an auto-generated Postman collection for all API endpoints:

`bash


Generate/update the Postman collection


pnpm run generate:postman
`

This creates b3-api.postman_collection.json with all service endpoints organized by route.

Quick Start:
1. Run pnpm run generate:postman
2. Import b3-api.postman_collection.json into Postman
3. Set jwt_token variable (copy b3-auth cookie from global.b3.fun)
4. Start testing!

📚 See README_POSTMAN.md for detailed documentation.

Scaffolding

This app comes with a powerful command line interface for Feathers. Here are a few things it can do:

`
$ npx feathers help # Show all commands
$ npx feathers generate service # Generate a new Service
`

Create a new Service

Use the Feathers CLI via pnpm:

`
pnpm dlx @feathersjs/cli generate service
`

MongoDB Extended Service Best Practices

This project uses a custom MongoDBExtendedService that extends the standard Feathers MongoDB service with additional type safety and functionality.

$3

When working with MongoDB collections in service methods, always use await this.db() instead of await this.getModel(params) for better type safety:

`typescript
// ✅ Recommended - Provides full type safety
const collection = await this.db();

// ❌ Avoid - Generic collection without proper typing
const collection = await this.getModel(params);
`

The db() method returns a properly typed Collection` which provides:
- Better TypeScript autocomplete and IntelliSense
- Compile-time type checking for document fields
- Enhanced refactoring support
- Prevention of runtime errors from typos

Help

For more information on all the things you can do with Feathers visit docs.feathersjs.com.