Checkout Moon Garden Here! »

Explore the Moon Garden Backend Application »

Table of Contents

1. About The Project
   • Background
   • Built With
   • API's Consumed
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. Land Acknowledgments
6. Contributors

About The Project

Whats growin on? Moon Garden helps you track your gardens and plants while offering recommendations based on the moon phase at every step of the way. You can also get information regarding the indigenous history of the land you are gardening on. We even threw in the weather, as a treat.

Using Moon Garden, users are able to:

• Register or sign-in using Google OAuth.
• See the current lunar phase with the corresponding gardening recommendation.
• Create Gardens to display on their Garden Dashboard.
• Search for plants by keyword and receive growing recommendations, then add plants to their garden.
• Add personal track planting details to each plant in a user's garden.
• View land acknowledgments based on IP address location or entered location.

(back to top)

Background

The tradition of lunar gardening has been practiced for as long as folks have been planting seeds and working the soil. It is believed by many cultures that the combination of the moon's illumination and its gravitational effect on earth's waters impact the gardening process. Moon Garden gives planting recommendations based on the various moon phases and provides garden tracking services for users.

When working with the land it is important to acknowledge whose land it is that is being worked. If you're curious about the history of your region, check out our Land Acknowledgments page.

Built With

API's Consumed

• FarmSense
• OpenFarm
• Native Land
• Google OAuth
• OpenWeather
• GeoPlugin
• MapQuest

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone this repository using SSH key

   $ git clone [email protected]:Moon-Garden/moon_garden_fe.git

2. Once cloned, you will have local copies of the directories you ran the clone command in. Use $ cd to navigate to the front end application directory.

   $ cd moon_garden_fe

3. Install the required gems utilizing Bundler:

• If Bundler is not installed, first run the following command.

  $ gem install bundler

• If Bundler is already installed or after you have installed it, run the following command.

  $ bundle install

4. There should be be text diplayed of the installation process that looks similar to below.

   Fetching gem metadata from https://rubygems.org/........
   Resolving dependencies...
   Using bundler 2.1.4
   Using byebug 11.1.3
   Fetching coderay 1.1.2
   Installing coderay 1.1.2
   Using diff-lcs 1.4.4
   Using method_source 1.0.0
   Using pry 0.13.1
   Fetching pry-byebug 3.9.0
   Installing pry-byebug 3.9.0
   Fetching rspec-support 3.10.1
   Installing rspec-support 3.10.1
   Fetching rspec-core 3.10.1
   Installing rspec-core 3.10.1
   Fetching rspec-expectations 3.10.1
   Installing rspec-expectations 3.10.1
   Fetching rspec-mocks 3.10.1
   Installing rspec-mocks 3.10.1
   Fetching rspec 3.10.0
   Installing rspec 3.10.0
   Bundle complete! 3 Gemfile dependencies, 12 gems now installed.
   Use `bundle info [gemname]` to see where a bundled gem is installed.

If there are any errors, verify that bundler, Rails, and your ruby environment are correctly setup.

5. Figaro installation

• Follow the figaro installation with the docs and get your OpenFarm, MapQuest, OpenWeather and Google Client keys.

  $ bundle exec figaro install

6. Add the keys to your newly created config/application.yml file and add it to your .gitignore file. Be sure to read the google API docs for a deeper undestanding of the app. Your config/application.yml file should look something like this:

   GOOGLE_CLIENT_ID: (YOUR CLIENT ID HERE)
   GOOGLE_CLIENT_SECRET: (YOUR CLIENT SECRET HERE)
   PLANT_TOKEN: (YOUR KEY HERE)
   MAPQUEST_KEY: (YOUR KEY HERE)
   WEATHER_KEY: (YOUR KEY HERE)

7. Start up your local server

   $ rails s

8. Open web browser and visit link to access the front end application http://localhost:3000. At this point, you should see the Moon Graden landing page!

(back to top)

Usage

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Land Acknowledgments

Moon Garden strives to join Native Land Digital in their mission to create spaces where non-Indigenous people can be challenged to learn more about the lands they inhabit, the history of those lands, and how to actively be part of a better future going forward together. As we learn more about the land surrounding each of us, we would like to take time to acknowledge the history of the territories we each garden in.

• Long Island Area - Montauk
• Denver Area - Dakȟóta (Western Dakota), Dakhóta (Eastern Dakota), Ute, Lakȟótiyapi (Lakota), Cheyenne, Arapaho
• Chesapeake Area - Chesapeake
• Chicago Area - Dakȟóta (Western Dakota), Dakhóta (Eastern Dakota), Illinois, Potawatomi
• Kenosha, Wisconsin Area - Dakȟóta (Western Dakota), Dakhóta (Eastern Dakota), Hoocąk (Ho-Chunk), Illinois, Potawatomi

(back to top)

Contributors

Thanks go to these wonderful people:

Jim R. (he/him)

Andrew K. (he/him)

Casey F. (they/she)

Jennifer H. (she/her)

Bryce W. (he/him)

Stephen W. (he/him)

This project follows the all-contributors specification.

(back to top)