San Diego DEVx Website

Welcome to the San Diego DEVx website repository! This project aims to build a vibrant community of developers in San Diego, providing a platform for networking, learning, and sharing knowledge.

Development Setup

Follow these instructions to set up the development environment and run the project locally.

Prerequisites

Make sure you have the following installed on your machine:

• Bun (latest version recommended)

Installation

1. Clone the repository:

git clone https://github.com/yourusername/san-diego-devx.git
cd san-diego-devx

2. Install dependencies:

bun install

3. Start the development server with the following command::

bun run dev

The site will be running at http://localhost:3000.

Environment Variables

Realtime doorbell interactions rely on Supabase Realtime. Create a Supabase project (free tier is fine) and add the following to .env.local:

NEXT_PUBLIC_SUPABASE_URL=<your-supabase-project-url>
NEXT_PUBLIC_SUPABASE_ANON_KEY=<your-public-anon-key>

These keys are safe to expose to the browser but should be scoped to the realtime channel only via Supabase RLS/policies.

Note: This project is being refactored to use styled-components exclusively. Please do not add new Tailwind classes. See styling guidelines for details.

Contributing

We welcome contributions from the community! If you have suggestions or improvements, feel free to open an issue or submit a pull request.

Guidelines

The project uses Prettier and ESLint for code formatting and linting. Integrating ESLint in your editor is recommended to ensure that the code formatting in addition to the linting rules are followed. For VSCode, you can use the ESLint extension.

Pre-commit hooks are in place to ensure that the code is properly formatted before a commit is added to the repo. The pre-commit hook runs the precommit script (bun run precommit).

For detailed code style and organization guidelines:

• File Conventions - File structure and organization patterns for all code files
• Styling Guidelines - Styled-components usage and migration from Tailwind
• Agent Guidelines - Complete coding standards for AI agents and developers

Steps to Contribute

1. Fork the repository
2. Create a new branch:

   git checkout -b feature-name

3. Make your changes and commit

   git add .
   git commit -m "Add some feature"

4. Push to the branch

   git push origin feature-name

5. Open a pull request on Github