bcfreeflight

api.bcfreeflight.com

This Node.js package powers the backend API for bcfreeflight.com, providing data access and services for free flight device and weather data. It is built in TypeScript, using AWS DynamoDB for data storage and offering type definitions, service abstractions, and a clean HTTP layer for seamless integration.

Features
Getting Started
Project Structure
Documentation
Helpful Tips
Contributing
License

Features

Device and Weather Data APIs for Free Flight applications
DynamoDB integration for scalable data storage
Modular architecture for easy maintainability
Typed interfaces for reliability and development speed
Bundled for serverless deployment

Getting Started

Prerequisites

Node.js (version 18.x or higher recommended)
npm package manager

Installation

Documentation

Comprehensive auto-generated documentation is available at:
https://bcfreeflight.com/api.bcfreeflight.com/
To generate/update local docs:
```
npm run docs
```
Then open docs/index.html in your browser.

Helpful Tips

TypeScript Best Practices: All public interfaces are typed. Use the definitions in src/interfaces for type-safe integrations.
Environment Variables: When deploying, configure your AWS credentials and DynamoDB resource names as required by your environment.
Testing: Consider writing tests for your services in a tests/ directory and mocking DynamoDB for local development.
Error Handling: All API responses are wrapped using the HTTP layer in src/http for consistent error handling.
AWS Lambda: Use the bundled code from dist/bundle.js for lightweight serverless deployment.

Contributing

Fork the repository
Create your feature branch (git checkout -b feature/my-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin feature/my-feature)
Open a pull request

License

MIT