Merge branch 'main' of github.com:firecmsco/firecms into main

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+Thank you for your interest in contributing to this project! If you are new to contributing to open source, please read
+the [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) guide.
+
+If you would like to make changes to the source, feel free to submit a PR!
+
+## Getting Started
+
+You can find the source code for the library under `lib`.
+The demo project used for development is under `example`.
+
+After pulling the code you just need to run
+
+```bash
+yarn
+yarn dev
+``` 
+
+to start the demo project.
+
+## Support and discussion
+
+Please join our [Discord channel](https://discord.gg/fxy7xsQm3m)  to discuss any details regarding adaptations. We are
+happy to help!
+
+You are encouraged to check with us before implementing any major changes to the library, that would like
+to be submitted as a PR.
+
+

README.md

@@ -159,20 +159,10 @@ happy to help!
 `[email protected]`
 
 
-## Development
+## Contributing
 
-If you would like to make changes to the source, feel free to submit a PR!
-
-When developing, the core library can be found under `lib`.
-There is an example project in the folder `example`.
-
-In order to run the project, you need to create a file
-called `firebase_config.ts` in `example/src`.
-
-That file needs to export a valid Firebase config, that you can get
-from your Firebase console when creating a webapp for your project.
-
-Then simply run `yarn` and `yarn dev`
+Check the [Contributing Guidelines](CONTRIBUTING.md)
+TLDR: Simply run `yarn` and `yarn dev`
 
 ## License
 

example/src/SampleApp/SampleApp.tsx

@@ -14,7 +14,7 @@ import { IconButton, Tooltip } from "@mui/material";
 import { GitHub } from "@mui/icons-material";
 
 import { firebaseConfig } from "../firebase_config";
-import { publicRecaptchaKey } from "../appcheck_config";
+// import { publicRecaptchaKey } from "../appcheck_config";
 import { ExampleCMSView } from "./ExampleCMSView";
 import logo from "./images/demo_logo.png";
 import { testCollection } from "./collections/test_collection";
@@ -33,13 +33,13 @@ import { booksCollection } from "./collections/books_collection";
 import { FirebaseApp } from "firebase/app";
 
 function SampleApp() {
-    const appCheckOptions: AppCheckOptions = {
-        providerKey: publicRecaptchaKey,
-        useEnterpriseRecaptcha: false,
-        isTokenAutoRefreshEnabled: true,
-        // debugToken: appCheckDebugToken,
-        forceRefresh: false
-    };
+    // const appCheckOptions: AppCheckOptions = {
+    //     providerKey: publicRecaptchaKey,
+    //     useEnterpriseRecaptcha: false,
+    //     isTokenAutoRefreshEnabled: true,
+    //     // debugToken: appCheckDebugToken,
+    //     forceRefresh: false
+    // };
 
     const githubLink = (
         <Tooltip

example/src/firebase_config.ts

@@ -0,0 +1,11 @@
+// Replace with your Firebase config
+export const firebaseConfig = {
+    apiKey: "AIzaSyBzt-JvcXvpDrdNU7jYX3fC3v0EAHjTKEw",
+    authDomain: "demo.firecms.co",
+    databaseURL: "https://firecms-demo-27150.firebaseio.com",
+    projectId: "firecms-demo-27150",
+    storageBucket: "firecms-demo-27150.appspot.com",
+    messagingSenderId: "837544933711",
+    appId: "1:837544933711:web:75822ffc0840e3ae01ad3a",
+    measurementId: "G-8HRE8MVXZJ"
+};