Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhruv9068/detectly
Detectly-Object Detection Website
https://github.com/dhruv9068/detectly
react-router reactjs tailwind-css tensorflow
Last synced: 18 days ago
JSON representation
Detectly-Object Detection Website
- Host: GitHub
- URL: https://github.com/dhruv9068/detectly
- Owner: Dhruv9068
- Created: 2024-09-09T20:39:23.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T21:09:05.000Z (2 months ago)
- Last Synced: 2024-10-09T17:40:56.718Z (about 1 month ago)
- Topics: react-router, reactjs, tailwind-css, tensorflow
- Language: JavaScript
- Homepage: https://detectly.netlify.app/
- Size: 17.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Detectly: AI Object Detection Web Application
**Detectly** is a real-time object detection web application built with TensorFlow.js and React.js. This project utilizes machine learning models to accurately detect objects from the user's camera feed, providing a seamless and interactive user experience.
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Real-time object detection** using TensorFlow.js
- **Responsive UI** with React.js and Tailwind CSS
- **Smooth animations** for an enhanced user experience using Animation.css
- **Cross-platform support**, compatible with modern web browsers
- **Easy-to-use interface** for an intuitive experience
## Technologies Used
- **Frontend**: React.js, Tailwind CSS, Animation.css
- **Machine Learning**: TensorFlow.js
- **Other**: JavaScript (ES6+), HTML5, CSS3
## Getting Started
To run this project locally, follow the instructions below.
### Prerequisites
Make sure you have the following installed:
- Node.js (version 14 or higher)
- npm or yarn (for package management)
You can download Node.js [here](https://nodejs.org/).
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Dhruv9068/Detectly.git
```
2. Navigate into the project directory:
```bash
cd Detectly
```
3. Install the required dependencies:
```bash
npm install
```
### Usage
To start the development server:
```bash
npm start
```
The app will be available at `http://localhost:3000`.
### Build for Production
To create a production build:
```bash
npm run build
```
This will generate the production-ready files in the `build` directory.
## Project Structure
```bash
.
├── public
├── src
│ ├── components # Reusable UI components
│ ├── pages # Main application pages
│ ├── services # Logic for TensorFlow model integration
│ ├── styles # Global and component-specific CSS
│ ├── App.js # Main app component
│ └── index.js # Entry point for React
├── package.json # Project metadata and dependencies
└── README.md # Project documentation
```
## Contributing
Contributions are welcome! If you'd like to contribute, feel free to submit a pull request or open an issue.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.