Skip to content

yash1744/walmsplit-next

Repository files navigation

An Easy Way to Manage Walmart Expenses

Features · Usage · Setting Up Locally · Tech Stack · Contributing · License


Features

  • Effortlessly Split and Share Walmart Expenses via Splitwise directly on the web

Usage

To use WalmartSplit, got to WalmartSplit follow these steps:

  1. Login with your Splitwise account to start using app.
  2. Go to the Walmart orders page.
  3. Copy the page source of a purchase.
  4. Paste the page source in the welcome page of app.
  5. Select Friends you want to Split with and Done...

Setting Up Locally

To set up locally, you'll need to clone the repository, copy the .env.template contents to .env.local file and set up the following environment variables:

  • NEXT_PUBLIC_SPLITWISE_API_TOKEN - your Splitwise consumer key (you can get one here)

  • DB_URI - your MongoDB URI

  • CIPHER_KEY - Your nodejs crypto module key

  • CIPHER_IV - Your nodejs crypto module IV

  • CIPHER_ALGO - Your nodejs crypto module Algorithm

  • JWT_SECRET - your jwt secret which can be any strong string

  • SPLITWISE_CONSUMER_KEY - your Splitwise consumer key (you can get one here)

  • SPLITWISE_CONSUMER_SECRET - your Splitwise consumer secret (you can get one here)

  • SPLITWISE_REDIRECT_URI - your Splitwise callback url (you can get one here)

Tech Stack

WalmartSplit is built using the following technologies:

  • Next.js : A framework for building web pages
  • MongoDB : A NoSQL database for caching the friends and group of users
  • Splitwise APIs : Integration with Splitwise for splitting expenses
  • Shadcn-UI : Design components for a great user experience
  • Vercel – deployments
  • TailwindCSS – styles

License

This project is licensed under the MIT License.

Acknowledgements

We would like to thank shadcn for providing excellent design components that enhance the user interface.

Contributing

We welcome contributions to WalmartSplit. To contribute, follow these steps:

  • Fork the repository.
  • Create a new branch for your feature or bug fix.
  • Make your changes and test them thoroughly.
  • Commit your changes and push them to your forked repository.
  • Open a pull request with a clear description of your changes.