CONTRIBUTING.md

Contributing to The Ton

🌐 Live App: https://the-ton.vercel.app/login
📖 Medium Story: I Built a Bridgerton-Inspired Social App for Friend Groups

Thank you for your interest in contributing to The Ton! 🪶

Getting Started

• Node.js 18+
• npm 9+
• Access to project-specific API keys (Supabase, OpenAI, etc.)

Important

Please contact the repository owner for information about the required API keys and configuration settings.

Setup

1. Clone the repository:

   git clone https://github.com/YOUR_USERNAME/TheTon.git
   cd TheTon

2. Install dependencies:

   npm install

3. Set up environment variables:

   cp .env.example .env.local

   Then fill in your keys in .env.local (see below).

4. Run the development server:

   npm run dev

   Open http://localhost:3000 in your browser.

Environment Variables

See .env.example for the full list. Never commit .env.local — it's in .gitignore.

Code Style

• TypeScript everywhere
• Vanilla CSS (no Tailwind)
• Components in src/components/
• Pages in src/app/

Pull Requests

1. Fork the repo and create a feature branch
2. Make your changes
3. Ensure npm run build passes
4. Submit a PR with a clear description

This project is licensed under the CC BY 4.0 License.

Attribution required — if you use this code or assets, you must credit Sathya Sravya Vallabhajyosyula.