https://github.com/imkkingshuk/cardetectai
https://github.com/imkkingshuk/cardetectai
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/imkkingshuk/cardetectai
- Owner: ImKKingshuk
- License: gpl-3.0
- Created: 2024-05-15T18:33:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-25T19:02:34.000Z (over 1 year ago)
- Last Synced: 2024-12-31T10:42:06.181Z (10 months ago)
- Language: TypeScript
- Size: 415 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CarDetectAI
Version- v1.0.0
Live Demo
Experience next-generation road safety with CarDetectAI. Our Object Detection system, powered by AI, detects cars, people, and objects in real-time, providing alerts for speeding, collision risks, and potential accidents. Stay informed and secure on the road with CarDetectAI.
Follow these steps to run CarDetectAI
#### Installation
```bash
bun install
OR
npm install
OR
yarn install
OR
pnpm install
```
##### Start app:
```bash
bun dev
OR
npm run dev
OR
yarn dev
OR
pnpm dev
```
Contributing
We welcome contributions from the community to make CarDetectAI better for everyone. Whether you're a developer, designer, or enthusiast, there are ways you can contribute.
### Getting Started
1. **Fork the Repository:** Start by forking the repository to your GitHub account.
2. **Clone your Fork::** Clone the forked repository to your local machine using the following command:
```bash
git clone https://github.com/ImKKingshuk/Hyper-Detect-AI.git
```
3. **Install dependencies:** Install dependencies:
```bash
bun install
OR
npm install
OR
yarn install
OR
pnpm install
```
### Making Contributions
1. **Create a New Branch:** Create a new branch for your contributions:
```bash
git checkout -b yourbranch/your-feature-name
```
2. **Always Sync Repo:** Before starting any work, sync your local repository with the upstream (original) repository to ensure you have the latest changes:
```bash
git fetch upstream
git checkout main
git merge upstream/main
```
3. **Code Changes:** Make the necessary code changes, improvements, or bug fixes in your branch.
4. **Testing:** Ensure that your changes are thoroughly tested. Run tests if applicable and make sure existing tests pass.
5. **Commit Changes:** Commit your changes with a clear and descriptive commit message:
```bash
git commit -m "Add feature: your-feature-name"
```
6. **Stay Updated To Avoid Conflicts::** While working on your feature, it's a good practice to frequently pull the latest changes from the upstream repository to avoid conflicts:
```bash
git pull upstream main
```
7. **Push your changes to your forked repository on GitHub::**
```bash
git push origin yourbranch/your-feature-name
```
8. **Create a Pull Request:** Open a pull request from your fork to the main repository. Provide a detailed description of your changes, why they are needed, and any relevant information.
😊 Thank You, We appreciate your contributions 😊