Skip to content

Useless Projects - RantSpace by Team Kranti #18

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file not shown.
Binary file not shown.
93 changes: 41 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,95 +1,84 @@
<img width="1280" alt="readme-banner" src="https://github.com/user-attachments/assets/35332e92-44cb-425b-9dff-27bcf1023c6c">

# [Project Name] 🎯

# RantSpace 🎯

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

### Team Name: Kranti

### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: Evan Augustion - College of Engineering, Trivandrum
- Member 2: Dia Promod - College of Engineering, Trivandrum
- Member 3: Arjun K.M. - College of Engineering, Trivandrum

### Project Description
[2-3 lines about what your project does]
RantSpace is the ultimate platform to get real and say exactly what’s on your mind. Users can share their rants and connect with others, receiving relatable feedback in a fun and engaging way.

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
Tired of holding back? Here, you can rant freely, whether it’s about your friend, boss, or even “Mathew chettan.” RantSpace allows you to express your frustrations without judgment.

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
Feeling annoyed? You might see rants like “Mathew chettan is a pottan.” In a better mood? Maybe you’ll see “Mathew chettan oru kidilam aanuu!!!” RantSpace taps into the vibe of what you’re saying and brings you responses that match your energy, so you’ll always feel heard and understood.
Comment on lines +14 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

Add content guidelines and moderation policies.

The current description raises concerns about potential misuse for cyberbullying or harassment. Consider:

  1. Adding clear content guidelines
  2. Implementing content moderation
  3. Including an anti-harassment policy
  4. Adding a code of conduct

This will help create a safer environment while still maintaining the fun aspect of the platform.


## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
- JavaScript
- React.js
- Firebase
- Tailwind CSS

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


### Implementation
For Software:
For Software:
Firebase (Backend)
React (Frontend)

# Installation
[commands]
git clone https://github.com/tinkerhub/useless_project_temp.git
cd useless_project_temp
npm install


# Run
[commands]
npm start


### Project Documentation
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
![Screenshot1](Screenshots\1.jpeg)
A clean and user-friendly interface showcases the main page with an empty text box, inviting users to engage.

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
![Screenshot2](Screenshots\2.jpeg)
The user begins typing their thoughts, capturing their rant in the designated text box.

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
![Screenshot3](Screenshots\3.jpeg)
The user's first rant about the chosen subject is successfully saved to the database, ensuring it is stored for future reference.

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*
![Screenshot4](Screenshots\4.jpeg)
The user inputs another rant regarding the same subject, continuing the discussion.

For Hardware:

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*

![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*
![Screenshot5](Screenshots\5.jpeg)
Similar rants related to the topic are fetched using our algorithm and displayed, enhancing user interaction and engagement.
Comment on lines +53 to +66
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Fix screenshot paths and improve accessibility.

  1. Use forward slashes in paths for cross-platform compatibility
  2. Add meaningful alt text for accessibility
  3. Consider adding image dimensions for better layout stability
-![Screenshot1](Screenshots\1.jpeg)
+![Homepage showing the main rant input interface](Screenshots/1.jpeg){width="800" height="600"}

Committable suggestion skipped: line range outside the PR's diff.


### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*
Demo Videos\RantSpace - Google Chrome 2024-11-03 02-10-06.mp4
Demo Videos\RantSpace - Google Chrome 2024-11-03 02-12-12.mp4

Our website is a delightfully useless platform where users can vent their frustrations by sharing rants that nobody asked for, with their identities always kept completely hidden. Through RantSpace, users type their grievances into a text box, which gets stored in our ever-growing database of random thoughts. When someone submits a rant, our haphazard algorithm searches for similar rants and displays them as if it matters. This quirky feedback loop connects users through their pointless frustrations, offering a hilarious experience without ever revealing who they are.

# Additional Demos
[Add any extra demo materials/links]

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- Evan Augustion: Refining the idea, setting up backend
- Dia Promod: UI/UX Development
- Arjun KM: setting up backend, fine-tuning UI

---
Made with ❤️ at TinkerHub Useless Projects
Expand Down
1 change: 1 addition & 0 deletions RantSpace
Submodule RantSpace added at 3ade1c
Binary file added Screenshots/1.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/3.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/4.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Screenshots/5.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.