Skip to content

theapache64/fig

Repository files navigation

fig

Twitter: theapache64

Use Google sheet as remote config

✨ Demo

Sheet:

Code:

suspend fun main() {
    val fig = Fig()
    fig.init(sheetUrl = "https://docs.google.com/spreadsheets/d/../edit?usp=sharing") // your Google sheet URL
    println("Fruit is '${fig.getValue("fruit", null)}'")
}

Output:

Fruit is 'apple'

⌨️ Usage

  1. 📄 Create a Google Sheet with two columns key and value
  1. 🔗 Choose "Anyone with link" and copy the link
  1. 🤝 Add dependency

latestVersion

repositories {
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    implementation("com.github.theapache64:fig:0.0.3")
}
Groovy:
repositories {
  maven { url 'https://jitpack.io' } // Add jitpack
}
dependencies {
  implementation 'com.github.theapache64:fig:0.0.3'
}
  1. ⌨️ Use Fig.init and Fig.getValue
suspend fun main() {
    val fig = Fig()
    fig.init(sheetUrl = "YOUR-GOOGLE-SHEET-URL-GOES-HERE")
    println("Fruit is '${fig.getValue("fruit", null)}'")
}
  1. 💻 Output
Fruit is 'apple'

▶️ Video Tutorial

If you want to see this library in practice, you can check out this video tutorial on YouTube: https://youtu.be/E8X94pCJ2zs

🚫 Limitations

  • Your value field can't have two data types. To solve this always wrap your number inputs with TO_TEXT function. Eg: =TO_TEXT("2.4")
  • This library uses an unofficial Google Sheets API to fetch data, which may stop working at any time. It's best to use this library only for small projects where you need quick, dynamic values without setting up something like Firebase (and honestly, most of my projects use this library as a config source and database, so if it crashes, I'll be crying right alongside you).

✍️ Author

👤 theapache64

Feel free to ping me 😉

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Open an issue first to discuss what you would like to change.
  2. Fork the Project
  3. Create your feature branch (git checkout -b feature/amazing-feature)
  4. Commit your changes (git commit -m 'Add some amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a pull request

Please make sure to update tests as appropriate.

❤ Show your support

Give a ⭐️ if this project helped you!

Patron Link Buy Me A Coffee

📝 License

Copyright © 2024 - theapache64

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This README was generated by readgen