/cagarweyne-chocolates

Search through a catalogue of delicious chocolates and favourite the ones you love! Log in and have all your favourite chocolates there for viewing! Built with React and Rails.

Primary LanguageRuby

Cagarweyne Chocolates

A Catalogue of chocolates, built with React.Js and Ruby on Rails

screenshot

Search through a catalogue of delicious chocolates and favourite the ones you love! Log in and have all your favourite chocolates there for viewing!

Built With

  • JavaScript
  • React.Js
  • Redux
  • Postgres
  • Flickity

Live Demo

Live Demo Link

Getting Started

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

Prerequisites

  • Node.Js
  • Postgres
  • Ruby on Rails
  • Yarn or NPM
  • Browser of any choice

Setup

  1. Clone repo git clone https://github.com/mrnadaara/cagarweyne-chocolates.git

  2. Go to repo directory cd cagarweyne-chocolates

  3. For Rails, install all gems bundle install

  4. For React, install all dependencies yarn install

  5. Define your postgres credentials by going to config/local_env.yml and replace the username and password with your own

  6. Setup the database by running rails db:migrate and then rails db:setup

  7. If for whatever reason the chocolates table is empty, run rails db:seed

Usage

  • Start development server rails server

  • OPTIONAL: You can have Webpack continuously re-bundle your react app by running ./bin/webpack-dev-server in a separate terminal

Deployment

Project was deployed to Heroku

Testing

  • For rails integration, request and unit testing run bundle exec rspec
  • For react redux testing run yarn test

Author

👤 Sharma'arke Ahmed

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Microverse for providing this project requirements and specifications

📝 License

This project is MIT licensed.