111bdb2062
This commit improves the Swagger documentation by using rswag to generate it from the request specs. The following changes were made: - All request specs in `spec/requests/api/v1/` were updated to use the rswag DSL. - The `spec/swagger_helper.rb` was configured to generate a `swagger.json` file. - The `config/database.yml` was updated to use environment variables, which makes it easier to use in different environments. - The generated `swagger.json` file is now based on the OpenAPI 3.0 specification.
🌱 Growstuff
Welcome to the Growstuff project.
You can find our app at https://www.growstuff.org
Growstuff is an open source/open data project for food gardeners. We crowdsource information on what our members are growing and harvesting, aggregate it, and make it available as open data via our API.
Growstuff was founded in 2012 and has been built by dozens of contributors. We are an inclusive, welcoming project, and encourage participation from people of all backgrounds and skill levels.
Want to contribute?
Don't ask to ask, the best way to get started is to fork the project, start a codespace and get hacking. Dive on in and submit your PRs!
Vibe Coding is more than okay, just make sure you indicate if you have done so and ensure there are tests.
Important links
For coders
Growstuff is built in Ruby on Rails and also uses JavaScript for frontend features. We welcome contributions -- see CONTRIBUTING for details.
- To set up your development environment, see Getting started.
- You may also be interested in our API.
For Home Automation enthusiasts
https://github.com/Growstuff/homeassistant-growstuff/
For designers, writers, researchers, data wranglers, and other contributors
There are heaps of ways to get involved and contribute no matter what your skills and interests.
You might like to check out:
- The New Contributor Guide page on our wiki, which has lots of detail for different areas
Here on Github, you might find these useful:
- Github Project Board has stories in "ready" that can be worked on.
- needs: design - tasks requiring high-level design
- needs: visual design - tasks requiring visual/graphical design
- needs: documentation
- needs: data - tasks requiring data entry, data design, data import, or similar
- curated:beginner - tasks that are ideal for beginner programmers or people new to the project
Feel free to comment on any of the issues on Github.
Contact
For more information about this project, contact info@growstuff.org.
Security Issues: If you find an authorization bypass or data breach, please contact our maintainers directly at maintainers@growstuff.org.