strapi-plugin-firebase-authentication 1.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Behon Baker.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+<img src="/Gen Types Logo.png" style="height: 70px; margin: 0px; border-radius: 12px;" />
+
+# Strapi Plugin Gen Types
+
+Generate types for the different collections, single types & components found in your application.
+
+![Screenshot of Gen Types UI in Strapi Admin Panel](/screenshot.jpeg)
+
+> This plugin is still in development. Please use with caution.
+
+> This plugin will not run in production. It is only meant to be used in development.
+
+## Installation
+
+```bash
+yarn add strapi-plugin-firebase-auth
+```
+
+```bash
+npm install strapi-plugin-firebase-auth
+```
+
+## Configuration
+
+You can configure the plugin by updating the `config/plugins.ts` file in your Strapi project.
+
+The following options are available:
+
+- `singleFile` - Whether to generate a single file for all types or separate files for each collection. Default: `false`
+
+```typescript
+// config/plugins.ts
+export default ({ env }) => ({
+  "firebase-auth": {
+    enabled: true,
+    config: {
+      FIREBASE_JSON_ENCRYPTION_KEY: env("FIREBASE_JSON_ENCRYPTION_KEY", "your-default-key"),
+    },
+  },
+});
+```
+
+The plugin will generate types for the collections found in the `api` folder of your Strapi project.
+
+It will also add a few extra interfaces like `User`, `Role`, `Media` etc.
+
+## Admin UI
+
+The plugin will add a new menu item `Generated Types`. This page will show the generated interfaces.
+
+You can expand each interface to see the fields and their types.
+
+Clicking on the copy button will copy the interface to your clipboard.
+
+## License
+
+MIT
+
+## Contributing
+
+I am super new to React. I prefer Nuxt. I am not sure if how I implemented the Admin UI is the best way to do it. I would appreciate any help in improving it. Thanks.
+
+Just fork the repo and create a PR. I will be happy to merge it.