bobb-Rob/shoppingify-v2

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Functionalities
  • 🚀 Live Demo
  • 🚀 Frontend Repository
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Shoppingify

Shoppingify uses a rails API only to create endpoints that serves this fullstack web application that will help users keep track of their shopping activities.

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Analysis showing where most of your spending goes
• Track your shopping history by noticing recurrent trends

Functionalities

• When I select the items tab, I can see a list of items under different categories.
• I can add a new item with name, category, note, and image.
• When I add a new item, I can select one from the existing categories or add a new one if the category does not exist 🔥
• When I select an item, I can see its details and I can choose to add the current list or delete the item.
• I can add items to the current list 😋
• I can increase the number of item in the list
• I can remove the item from the list
• I can save/update the list with a name (user can have only one active list at a time)
• I can toggle between editing state and completing state
• When I am at completing state, I can save my progress by selecting the item
• I can cancel the active list 😄
• When I try to cancel a list, I can see a confirmation notification
• I can see my shopping history and I can see the details of it
• I can see some statistics: top items, top categories, and monthly comparison.
• I can search for items

(back to top)

🚀 Live Demo

• Base url
• Live Demo of Frontend

(back to top)

🚀 Frontend Repository

• Frontend Repository

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need have folowwing installed on your machine:

- Node.js
- Ruby:latest
- Ruby on Rails 7+
- Bundle installer (`gem install bundler`)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/bobb-Rob/shoppingify-v2.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following commands:

  bin/rails db:create

  bin/rails db:migrate

  bin/rails server

Run tests

To run tests, run the following command:

  bin/rails spec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Name	Github	Twitter	LinkedIn
Robertson Akpan	@bobb-rob	@___Robertson	@RobertsonAkpan

(back to top)

🔭 Future Features

• Sync your phone message with in-app budget tool to help tract spending and overtime help restrain unecessary spending
• Add another user as co-planner and event purchase helper
• Attach summary note to completed list or canceled list

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, and would love to see how we monetize this kind of app, you can reach out to me.

(back to top)

🙏 Acknowledgments

I would like to thank DevChallenges for this inspiring project design.

(back to top)

📝 License

This project is MIT licensed.