Welcome to MyCommunity, a platform where individuals from all walks of life come together to support, uplift, and connect with one another. Our mission is to foster a sense of belonging, promote meaningful relationships, and celebrate the power of community.

Join us in creating a supportive and inclusive space where everyone can thrive, share, and grow together.

• Next.js
• TypeScript
• Tailwind CSS
• DaisyUI

• Django
• Django REST Framework
• PostgreSQL
• Simple JWT for authentication

# Clone the repository
git clone https://github.com/19Caitlyn94/my-community.git

# Install Python dependencies
cd my-community/backend
poetry install

# Set up environment variables
echo .env
# Edit .env with the database credentials and secret key

# Run migrations
poetry run python manage.py migrate

# Create a superuser
poetry run python manage.py createsuperuser

# Start the development server
export DEBUG=True
poetry run python manage.py runserver 8000

# Navigate to frontend directory
cd my-community/frontend

# Install dependencies
npm install

# Set up environment variables
echo .env.local
# Edit .env.local with the API URL

# Start the development server
npm run dev

Open http://localhost:3000 with your browser. This project uses next/font to automatically optimize and load Inter, a custom Google Font.

cd backend
poetry run python manage.py test

For end-to-end and component testing, we use Cypress:

cd frontend
npm run cypress:open  # Open Cypress GUI
npm run cypress:run   # Run tests in headless mode

See the documentation for testing guidelines.

The API documentation is available at /api/docs/ when running the backend server.

Key endpoints:

• /api/auth/ - Authentication endpoints
• /api/users/ - User management
• /api/communities/ - Community operations
• /api/posts/ - Post operations

DJANGO_SECRET_KEY=your-secret-key
DB_NAME=your-db-name
DB_USER=your-db-user
DB_SECRET=your-db-password

NEXT_PUBLIC_API_URL=http://localhost:8000

Conventional Commits specification for commit messages.

Format: <type>[optional scope]: <description>

Example: feat(auth): implement email verification flow

Format: {type}/{description}[/{ticket-id}]

Example: feature/email-verification/MC-244

Semantic Versioning for version numbers:

Format: MAJOR.MINOR.PATCH

Example: 1.2.3

• MAJOR: Breaking changes
• MINOR: New features (backwards-compatible)
• PATCH: Bug fixes (backwards-compatible)

1. Mobile-First Approach

   • Design and develop for mobile devices first
   • Progressive enhancement for larger screens

2. Layout Structure

   • CSS Grid for main layout
   • Flexbox for component-level layouts