https://github.com/the-wee-lad/tcs-hackathon-hack-o-gravity
This is the repo for submitting our work for the hack o gravity hackathon
https://github.com/the-wee-lad/tcs-hackathon-hack-o-gravity
hackathon hackathon-project
Last synced: 8 months ago
JSON representation
This is the repo for submitting our work for the hack o gravity hackathon
- Host: GitHub
- URL: https://github.com/the-wee-lad/tcs-hackathon-hack-o-gravity
- Owner: The-Wee-Lad
- Created: 2025-10-18T10:31:41.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-18T10:50:27.000Z (9 months ago)
- Last Synced: 2025-10-19T06:34:19.296Z (8 months ago)
- Topics: hackathon, hackathon-project
- Language: JavaScript
- Homepage: https://tcs-hackathon-hack-o-gravity.vercel.app/
- Size: 2.72 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🕵️♂️ Whistle Blower
A secure, anonymous whistleblowing platform designed to empower individuals to report misconduct without fear of retaliation. Built as a monorepo with both client and server applications.
## 🌐 Live Frontend
🔗 [Access the frontend here](https://tcs-hackathon-hack-o-gravity.vercel.app/)
---
## 📁 Monorepo Structure
```
whistle-blower/
├── client/ # Frontend application (e.g., React)
├── server/ # Backend application (e.g., Node.js/Express)
├── README.md # Project documentation
└── package.json # (optional) For managing shared scripts or dependencies
````
---
## 🚀 Features
- Anonymous reporting system
- Secure data handling
- User-friendly frontend interface
- Admin and user roles (if applicable)
- REST API for secure data transfer
---
## 🧑💻 Tech Stack
### Frontend (Client)
- Framework: [React.js](https://reactjs.org/)
- UI Library: (e.g., Tailwind CSS, Material UI)
- Deployment: [Vercel](https://vercel.com/)
### Backend (Server)
- Runtime: [Node.js](https://nodejs.org/)
- Framework: [Express.js](https://expressjs.com/)
- Database: (e.g., MongoDB, PostgreSQL)
- Authentication: (e.g., JWT, OAuth, or custom logic)
---
## 📦 Getting Started
### Prerequisites
- Node.js >= 16.x
- npm or yarn
- MongoDB/PostgreSQL instance (if needed)
### Clone the Repository
```bash
git clone https://github.com/your-username/whistle-blower.git
cd whistle-blower
````
### Setup Client
```bash
cd client
npm install
npm run dev
```
### Setup Server
```bash
cd server
npm install
npm run dev
```
---
## ⚙️ Environment Variables
Each app (`client/`, `server/`) may have its own `.env` file. Example:
### `server/.env`
```
PORT=5000
MONGO_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
```
### `client/.env`
```
VITE_API_URL=http://localhost:5000/api
```
> 🛡️ **Do not commit `.env` files** — keep secrets safe.
---
## 🏁 Roadmap / TODO
* [ ] Implement encrypted data storage
* [ ] Add role-based dashboards
* [ ] Improve accessibility and UI/UX
* [ ] Add tests (unit/integration)
```