Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Death Finder #16

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+6,694 −54
Open

The Death Finder #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa1c177
final commit
callmesidhu Nov 2, 2024
ebad521
final commit finished
callmesidhu Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .eslintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["next/core-web-vitals", "next/typescript"]
}
40 changes: 40 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# env files (can opt-in for commiting if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
21 changes: 21 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 S SIDHARTH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
72 changes: 18 additions & 54 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,95 +1,59 @@
<img width="1280" alt="readme-banner" src="https://github.com/user-attachments/assets/35332e92-44cb-425b-9dff-27bcf1023c6c">

# [Project Name] 🎯
# [The Death Finder] 🎯


## Basic Details
### Team Name: [Name]
### Team Name: [callmesidhu]


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: Sidharth S - College of Engineering Trivandrum

### Project Description
[2-3 lines about what your project does]
This app will helps you to find when will you die and how will you die.
Comment on lines +3 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix grammatical errors in project description

The project description contains several grammatical errors that should be corrected:

-This app will helps you to find when will you die and how will you die.
+This app helps you find when and how you will die.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# [The Death Finder] 🎯
## Basic Details
### Team Name: [Name]
### Team Name: [callmesidhu]
### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: Sidharth S - College of Engineering Trivandrum
### Project Description
[2-3 lines about what your project does]
This app will helps you to find when will you die and how will you die.
# [The Death Finder] 🎯
## Basic Details
### Team Name: [callmesidhu]
### Team Members
- Team Lead: Sidharth S - College of Engineering Trivandrum
### Project Description
This app helps you find when and how you will die.
🧰 Tools
🪛 LanguageTool

[grammar] ~14-~14: The modal verb ‘will’ requires the verb’s base form.
Context: ... ### Project Description This app will helps you to find when will you die and how w...

(MD_BASEFORM)

[grammar] ~14-~14: Did you mean ‘when you will die’?
Context: ...on This app will helps you to find when will you die and how will you die. ### The Prob...

(HOW_I_CAN)

[typographical] ~14-~14: Except for inverted sentences, ‘will you’ requires a question mark at the end of the sentence.
Context: ...d when will you die and how will you die. ### The Problem (that doesn't exist) T...

(MD_PRP_QUESTION_MARK)


### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
To find the user is dead or when will he die

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
How are you solving it? Keep it fun!
Comment on lines 16 to +20
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Complete the solution section and improve problem statement formatting

The problem statement needs proper punctuation, and the solution section still contains placeholder text. Consider:

-To find the user is dead or when will he die
+To determine if a user is dead or predict when they will die.

-How are you solving it? Keep it fun!
+We use advanced "guesswork" and totally reliable random predictions to tell users about their impending doom, bringing humor to the otherwise morbid topic of mortality.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
To find the user is dead or when will he die
### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
How are you solving it? Keep it fun!
### The Problem (that doesn't exist)
To determine if a user is dead or predict when they will die.
### The Solution (that nobody asked for)
We use advanced "guesswork" and totally reliable random predictions to tell users about their impending doom, bringing humor to the otherwise morbid topic of mortality.
🧰 Tools
🪛 LanguageTool

[typographical] ~17-~17: Except for inverted sentences, ‘will he’ requires a question mark at the end of the sentence.
Context: ...o find the user is dead or when will he die ### The Solution (that nobody asked fo...

(MD_PRP_QUESTION_MARK)


## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
- TypeScript,html,css
- Next.js,tailwind.css
- next,clsx,react-router
- vercel,github,vscode,chatgpt api for response(not integrated)

For Hardware:
- [List main components]
- [List specifications]
- [List tools required]

### Implementation
For Software:
# Installation
[commands]
npm install

# Run
[commands]
npm run dev
Comment on lines 24 to +37
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve technical documentation formatting and completeness

The technical section needs better organization and more detailed instructions:

  1. Use consistent formatting for technology lists
  2. Add system requirements
  3. Include more detailed setup instructions
-  TypeScript,html,css 
-  Next.js,tailwind.css
-  next,clsx,react-router
-  vercel,github,vscode,chatgpt api for response(not integrated)
+### Technologies
+- Frontend:
+  - TypeScript
+  - HTML/CSS
+  - Next.js
+  - Tailwind CSS
+- Libraries:
+  - clsx
+  - react-router
+- Development Tools:
+  - Vercel (deployment)
+  - VS Code
+  - GitHub
+
+### Prerequisites
+- Node.js (v14 or higher)
+- npm or yarn
+
+### Setup Instructions
+1. Clone the repository
+   ```bash
+   git clone [repository-url]
+   cd [project-directory]
+   ```
+2. Install dependencies
+   ```bash
+   npm install
+   ```
+3. Start development server
+   ```bash
+   npm run dev
+   ```


### Project Documentation
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
For Software: https://github.com/callmesidhu/Nextjs-TinkerHub-Useless-project

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*

For Hardware:

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*
![Desktop - 1](https://github.com/user-attachments/assets/83ae7d2d-c11d-4a59-930c-b029b1608706)

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*

# Build Photos
![Components](Add photo of your components here)
*List out all components shown*

![Build](Add photos of build process here)
*Explain the build steps*

![Final](Add photo of final product here)
*Explain the final build*

### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
https://drive.google.com/file/d/1Ao50cQrl4AreS28SMOIxIAhJRD_1CGLt/view?usp=sharing

# Additional Demos
[Add any extra demo materials/links]
https://callmesidhu-useless-project.vercel.app
Comment on lines 39 to +52
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Format links and headings according to Markdown best practices

  1. Use proper markdown link syntax instead of bare URLs
  2. Fix heading hierarchy
  3. Add descriptions for links
-### Project Documentation
-For Software: https://github.com/callmesidhu/Nextjs-TinkerHub-Useless-project
+## Project Documentation
+- [GitHub Repository](https://github.com/callmesidhu/Nextjs-TinkerHub-Useless-project) - Source code and documentation

-# Video
-  https://drive.google.com/file/d/1Ao50cQrl4AreS28SMOIxIAhJRD_1CGLt/view?usp=sharing
+## Project Demo
+- [Demo Video](https://drive.google.com/file/d/1Ao50cQrl4AreS28SMOIxIAhJRD_1CGLt/view?usp=sharing) - Watch the project in action
-# Additional Demos
-  https://callmesidhu-useless-project.vercel.app
+- [Live Demo](https://callmesidhu-useless-project.vercel.app) - Try the application yourself
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Project Documentation
For Software:
# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
For Software: https://github.com/callmesidhu/Nextjs-TinkerHub-Useless-project
![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*
For Hardware:
# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*
![Desktop - 1](https://github.com/user-attachments/assets/83ae7d2d-c11d-4a59-930c-b029b1608706)
![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*
# Build Photos
![Components](Add photo of your components here)
*List out all components shown*
![Build](Add photos of build process here)
*Explain the build steps*
![Final](Add photo of final product here)
*Explain the final build*
### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
https://drive.google.com/file/d/1Ao50cQrl4AreS28SMOIxIAhJRD_1CGLt/view?usp=sharing
# Additional Demos
[Add any extra demo materials/links]
https://callmesidhu-useless-project.vercel.app
## Project Documentation
- [GitHub Repository](https://github.com/callmesidhu/Nextjs-TinkerHub-Useless-project) - Source code and documentation
# Diagrams
![Desktop - 1](https://github.com/user-attachments/assets/83ae7d2d-c11d-4a59-930c-b029b1608706)
## Project Demo
- [Demo Video](https://drive.google.com/file/d/1Ao50cQrl4AreS28SMOIxIAhJRD_1CGLt/view?usp=sharing) - Watch the project in action
- [Live Demo](https://callmesidhu-useless-project.vercel.app) - Try the application yourself
🧰 Tools
🪛 Markdownlint

39-39: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)

47-47: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)

40-40: null
Bare URL used

(MD034, no-bare-urls)

49-49: null
Bare URL used

(MD034, no-bare-urls)

52-52: null
Bare URL used

(MD034, no-bare-urls)


## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- Sidharth: Full work


---
Made with ❤️ at TinkerHub Useless Projects
Expand Down
7 changes: 7 additions & 0 deletions next.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import type { NextConfig } from "next";

const nextConfig: NextConfig = {
/* config options here */
};

export default nextConfig;
Loading