npm-briefcase
v1.0.0
Published
SDK to build apps on top for Briefcase
Readme
Briefcase App Store Development Package
Welcome to the official npm package for developing applications for the Briefcase App Store. This package is designed to streamline the development process, allowing you to focus on creating innovative and user-friendly applications for the Briefcase platform.
Backend Features Supported
The Briefcase App Store supports a wide range of backend features to enhance your application's capabilities. These include:
- Redis: Utilize this in-memory data structure store as a database, cache, and message broker.
- Mixpanel: Integrate analytics into your application to track user interactions and data.
- MongoDB: Use this source-available cross-platform document-oriented database program.
- OpenAI: Incorporate AI capabilities into your app with OpenAI's powerful API.
- Pinecone: Leverage this vector database for building high-performance, large-scale machine learning applications.
- AWS S3: Store and retrieve any amount of data at any time using Amazon Simple Storage Service (Amazon S3).
- Pusher: Add real-time bidirectional communication between your servers, apps, and devices.
- Cloudinary: Manage your application’s media assets in the cloud with ease.
Frontend Development
For developing the frontend of your applications, the Briefcase App Store provides a suite of in-house components. These components are designed to help you build intuitive and engaging user interfaces with ease. Utilize our pre-built components for forms, navigation, data display, and more to accelerate your development process and maintain consistency across the Briefcase platform.
Flexibility to Add Dependencies
In addition to the supported features, developers are free to add any dependencies of their choice to their application. This flexibility allows you to tailor your app to meet specific needs and functionalities, ensuring a custom fit for the Briefcase App Store.
Development Keys and Dependency Management
For the development of applications that leverage Redis, MongoDB, or any other supported backend features, you are required to use the API key available in the developer portal. This key is crucial for accessing real data and interactions, facilitating effective testing and development of your application. Upon preparing your application for integration with the Briefcase platform, rest assured that Briefcase will handle the management of these essential dependencies. For incorporating additional dependencies into your application, you have the option to either provide your API key to Briefcase, ensuring it remains encrypted and secure, or allow Briefcase to manage this process on your behalf. Should you prefer the latter, please reach out to [email protected]. This approach guarantees that your application benefits from the latest features and security updates without the need for manual intervention.
Getting Started
To begin developing your application for the Briefcase App Store, start by installing this npm package in your project:
