Skip to content

Repository files navigation

🍋 Lemonade Tycoon

Project Description

Lemonade Tycoon is an interactive simulation game where players run their own lemonade stand. The objective is to manage resources such as money, lemons, and upgrades, while maximizing profits through selling lemonade to customers. The game features several upgrades and tools, including coolers, radio ads, franchise kits, and automatic sellers, all aimed at growing your lemonade business.

The game also features a feedback loop from customers, dynamic sales history, and real-time interactions with customers based on game upgrades, allowing users to manage and optimize their lemonade stand in a fun and engaging way.

Table of Contents (Optional)

How to Install and Run the Project

  1. Clone the repository to your local machine:

    git clone https://github.com/yourusername/lemonade-tycoon.git
  2. Navigate into the project directory:

    cd lemonade-tycoon
  3. Install dependencies:

    npm install
  4. Start the development server:

    npm start
  5. Open your browser and visit http://localhost:3000 to play the game.

How to Use the Project

  • Main Game Mechanics:

    • Buy Lemons to make lemonade.
    • Set a price for your lemonade.
    • Sell lemonade to customers, optimizing for profit.
    • Purchase upgrades such as coolers, radio ads, and automatic sellers to improve your business.
  • Upgrades and Tools:

    • Cooler: Reduces the cost of lemons by making them colder, appealing to more customers.
    • Radio Ads: Increase customer inflow by advertising your lemonade stand.
    • Franchise Kit: Enables you to sell lemonade at a faster rate, scaling up your business.
    • Auto Seller: Automates lemonade sales at regular intervals.
  • Customer Feedback:

    • Based on the quality of your lemonade and the price, customers will leave feedback. Pay attention to this feedback to optimize your business for higher profits.
  • Sales History:

    • The game tracks sales and earnings over time, which is displayed in a bar chart. Use this data to understand your performance and adjust your strategies.

Credits

  • Developer: DevFaith
  • Libraries Used:
    • React.js
    • Recharts (for charts)
    • Tailwind CSS (for styling)
    • React hooks (useState, useEffect)

Special thanks to the open-source community for the libraries and tools that made this project possible.

License

This project is licensed under the MIT License - see the LICENSE file for details.

How to Contribute to the Project

  1. Fork this repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a Pull Request with a description of what you’ve added or changed.

Tests

To run tests (if any):

  1. Ensure you have installed all dependencies.

  2. Run the test suite:

    npm test

Additional Sections (Optional)

Badges

You can include badges related to your project like build status, test coverage, etc. Example:

![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
![License](https://img.shields.io/badge/license-MIT-blue)

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages