lacompra-JSON

Table of Contents

• Description
  • Demonstration Video
• Usage
  • Locally
  • Docker
• Contributions
• Contributors
• License

Description

Configure a JSON with your usual items, mark them when they are missing and get your shopping list! Application built with React, JavaScript, Pico CSS and Docker.

The project has been dockerized to simplify usage and ensure a consistent environment. You can run the application within a Docker container, which includes all necessary dependencies.

Demonstration Video

Usage

• Clone the repository:

  git clone https://github.com/antonioalanxs/lacompra-JSON.git

• Configure your list frontend/src/data/items.json with your habitual items. For example:

  {
      "Oils, Spices, and Sauces": [
          "Olive oil", "Black pepper", "Garlic powder", "Tomato sauce", "Pesto"
      ],
      "Snacks": [
          "Almonds", "Popcorn", "Potato chips", "Pretzels", "Chocolate bars", 
          "Granola bars", "Trail mix", "Cashews", "Pistachios", "Fruit snacks", 
          "Crackers", "Cheese sticks", "Rice cakes", "Beef jerky", "Dried fruit"
      ],
      "Cleaning Supplies": [
          "Detergent", "Disinfectant spray", "Glass cleaner", "Paper towels", "Garbage bags"
      ],
      "Frozen Foods": ["Frozen pizza", "Ice cream", "Frozen vegetables"],
      "Beverages": ["Water", "Orange juice", "Coffee", "Tea", "Soda"]
  }

• Run the application. You can do it Locally or via Docker.

Locally

To use the application locally, follow these steps:

• Navigate to the project directory:

  cd lacompra-JSON/frontend

• Make sure you have Node.js and npm installed. You can install it via apt:

  sudo apt update && \
  sudo apt install nodejs && \
  sudo apt install npm

• Make sure you have Vite installed. You can install it via npm:

  sudo apt update && \
  npm install -g create-vite

• Finally, run the application:

  npm run dev

  The application is started on your localhost:5173.

Docker

If you prefer to use Docker to run the application, follow these steps:

• Make sure you have Docker installed on your machine. You can install it via apt:

  sudo apt update && \
  sudo apt install docker.io

• Navigate where docker-compose.yml is located:

  cd lacompra-JSON/

• Finally, execute it:

  docker compose up

  The application is started on your localhost:5173.

  To stop the application, simply run:

  docker compose down

Contributions

If you would like to contribute to the project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix (git checkout -b feature/new-feature).
3. Make your changes and commit them following the Conventional Commits format (git commit -m 'feat: add new feature' or fix: correct a bug).
4. Push your branch to the remote repository (git push origin feature/new-feature).
5. Create a Pull Request.

Contributors

License

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