Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 2.45 KB

README.md

File metadata and controls

85 lines (52 loc) · 2.45 KB
Raw

CronyGlasses

CronyGlasses is a Vite-powered React application showcasing the most demanded drinks in India, allowing users to place orders.

Table of Contents

  • Installation
  • Usage
  • Contributing
  • License

Installation

To install and run CronyGlasses, ensure you have Node.js and npm installed. Clone the repository and install the necessary dependencies.

# Clone the repository
git clone https://github.com/freedompraise/CronyGlasses.git

# Change directory to the project folder
cd CronyGlasses

# Install the required packages
npm install

# Run the development server
npm run dev

Running the Tests

To run the tests, use the following command:

npm test

Usage

To use CronyGlasses, open your browser and navigate to http://localhost:3000/. You'll see a list of popular drinks in India. Select any drink to view details such as price, ingredients, and ratings. You can place an order by clicking on the order button and completing the form.

My Journey with CronyGlasses

CronyGlasses started as a Django FullStack app in 2022, but due to responsive issues and deployment challenges, I transitioned it to React and Tailwind after learning these technologies. It's an E-commerce store built using React with a Supabase database, and deployed on Vercel.

The app uses the useContext hook for handling carts and real-time updates, including order history.

If I Had to Do It Again:

  • Define color variables for light and dark themes
  • Write tests for major functionalities
  • Separate concerns if handling the backend
  • Consider using a larger library like Redux for state management
  • Implement loading pages

Contributing

CronyGlasses is open-source, welcoming contributions. If you'd like to contribute:

  • Fork the repository on GitHub
  • Create a new branch for your feature or bug fix
  • Make your changes and commit them
  • Push your branch to your forked repository
  • Create a pull request to the main branch of CronyGlasses
  • Await feedback or approval

You can also report issues, suggest features, or ask questions on the issues page.

Current contributors:

  • Praise Dike @freedompraise
  • Mayur Chaure @mr-mayurchaure

Support:

License

CronyGlasses is licensed under the Apache License 2.0. See LICENSE for more details.