A Bowl Of Cherries

An event planning application built with a Ruby on Rails API backend and a React and Redux frontend.

Description

This app was built for the Flatiron School React project and is meant to let a user see all the upcoming events by month, listed by date, to see which events he or she would like to attend in the future. Any user that signs up, can log in, be automatically logged in, see what events other users have added to any month, add his or her own event, delete his or her own event, and search an event within a month by the event's name and/or description. A user can add or delete as many events as he or she would like. A user can only delete events created by his or herself, not others. All events are listed by the date in ascending order.

Frontend: HTML, CSS, React, Redux, React Bootstrap -> here

Backend: Rails API

Local Installation

To install and run the app on your local machine:

1. Fork and click the green Clone or download button above and click the copy to clipboard button (for both a_bowl_of_cherries_frontend & a_bowl_of_cherries_backend)
2. Open your Terminal with two tabs
3. Direct the first tab to a_bowl_of_cherries_backend, run git clone [paste the link from step 1]
4. Direct second tab to a_bowl_of_cherries_frontend, run git clone [paste the link from step 1]

• In the first tab for a_bowl_of_cherries_backend:

5. Run bundle install to install the necessary gems and dependencies
6. Run rails db:create to create a database
7. Run rails db:migrate to perform the database migrations
8. Run rails db:seed to fill the database with month information
9. Create an .env file in the root directory and add this inside it JWT_KEY="put any word you'd like here" to use JWT

Note: Since the .env file will not contain any sensitive information, you do not need to add it to your .gitignore file, but usually a .env file should not be tracked, committed or pushed to Github.

10. Run rails s to access and use the Rails API and open the server

• In the second tab to a_bowl_of_cherries_frontend:

11. Run npm install && start to have the browser open A Bowl Of Cherries' homepage

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/LehuaRyon/a_bowl_of_cherries_backend. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Ukulele's project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.