Skip to content

itsnileshgosavi/logo-detector

Repository files navigation

LOGO DETECTOR

License

This is a simple project to detect logos in images.

Support the Developer - "Buy Me A Coffee"

📑 Table of Contents

🎉 Features

  • Secure Authentication - Secure authentication using Jason Web Tokens and Bcrypt.
  • Detect Logo - Detect the logo in an image using Clarifai.
  • Detect Logo in the Image using AI - Detect the logo in an image using AI Powered Google Generative AI.
  • Delete Account - Delete your account whenever you want.

⚙️ Prerequisites

Make sure you have the following installed on your development machine:

  • Node.js (version 16 or above) - preferred v22.x.x
  • NPM (version 7 or above)

🚀 Getting Started

Follow these steps to get started with the Logo Detector project:

  1. Clone the repository:

     git clone https://github.com/itsnileshgosavi/logo-detector
  2. Navigate to the project directory:

    cd logo-detector
  3. Install the dependencies:

    npm i

    or

    npm install
  4. Start the development server:

    npm run dev

📜 Available Scripts

  • npm run dev - Starts the development server.
  • npm build - Builds the production-ready code.
  • npm lint - Runs ESLint to analyze and lint the code.

📂 Project Structure

The project structure follows a standard React application layout:

logo-detector/
  ├── node_modules/      # Project dependencies
  ├── public/            # Public assets
  ├── src/               # Application source code
  │   ├── components/    # React components 
  │   ├── Globals.css/   # CSS stylesheets
  │   ├── lib/           # Utility functions
  │   ├── Layout.js      # Application entry point
  │   └── page.js        # Main rendering page
  ├── .eslintrc.json     # ESLint configuration
  ├── middleware.js      # Middleware
  ├── postcss.config.js  # PostCSS configuration
  ├── tailwind.config.js # Tailwind CSS configuration
  ├── jsconfig.json      # JavaScript configuration
  └── next.config.js     # Next configuration

🤝 Contribution

We welcome contributions to the project. To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a pull request.

📄 License

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