PlantSort is a Rails 8 application designed to help gardeners organize and manage plants grown food, medicine, etc. With a structure reminiscent of a spreadsheet but more visually dynamic, PlantSort enables users to categorize plants by types like "Annual," "Perennial," "Fruit," "Vegetable," and "Medicinal." Users can create, edit, and categorize plants, allowing them to filter and view their collection by specific criteria. PlantSort brings a more interactive, gardener-friendly approach to plant organization than a typical spreadsheet.
- User Authentication: Users can sign up, log in, and manage their accounts (using Rails 8’s built-in authentication).
- Plant Management: Users can add, edit, and delete plants.
- Categorization: Assign plants to multiple categories for better organization.
- Filter by Category: Quickly filter plants by categories using Turbo and Stimulus for a smooth user experience.
To run PlantSort locally:
-
Clone the repository:
git clone https://github.com/onathjan/plantsort.git cd plantsort -
Install dependencies: Make sure you have Bundler installed, then run:
bundle install -
Set up the database:
rails db:create db:migrate db:seed -
Run the server:
rails server -
Open the app in your browser: Go to http://localhost:3000
- Sign Up: Create an account to start managing plants.
- Add Plants: Fill in details like common name and taxonomic name, then assign categories.
- Filter by Categories: Use the category buttons on the index page to filter plants.
- Ruby on Rails 8: For the application backend.
- Bulma: CSS framework for styling.
- Turbo: To handle filtering plants without page reloads.
- Stimulus: For enhancing JavaScript functionality.
No future improvements are planned at the moment, but if you have an idea for a feature that would benefit the app don't hesitate to reach out at [email protected]
- Fork the repository.
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am "Add some feature" - Push to the branch:
git push origin my-new-feature - Submit a Pull Request.
MIT No Attribution
Copyright (c) 2024 Onathjan
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.