Skip to content

Home

Jump to bottom
Rohit Dasgupta edited this page Sep 25, 2025 · 4 revisions

Welcome to the UF r/place Wiki!

This wiki contains comprehensive documentation for the UF r/place project - a modern, extensible r/place clone built with AWS serverless architecture.

📚 Documentation

Getting Started

Project Information

🚀 Quick Links

For New Contributors

  1. Start with Getting Started to set up your development environment
  2. Read AWS Configuration to configure your AWS credentials
  3. Review Project Overview to understand the architecture
  4. Check Contributing for development workflow and guidelines
  5. Browse the existing code structure described in Project Overview

🏗️ Project Structure

UF_r-place/
├── infra/          # AWS CDK Infrastructure  
│   ├── lib/        # CDK constructs and stacks
│   └── lambda/     # Lambda function handlers
└── web/            # Next.js Frontend Application
    └── app/        # App Router pages and components

⚡ Quick Start Commands

# Clone and setup
git clone https://github.com/ufosc/UF_r-place.git
cd UF_r-place
npm install

# Deploy backend
npm run cdk:bootstrap  # First time only
npm run cdk:deploy

# Run frontend
npm run dev

# Cleanup (when done)
npm run destroy       # Remove all AWS resources

🛠️ Technologies Used

  • Frontend: Next.js 14, React 18, TypeScript
  • Backend: AWS Lambda, API Gateway, CDK
  • Infrastructure: AWS CDK, CloudFormation
  • Development: npm workspaces, ESLint, esbuild

📖 Additional Resources

🤝 Contributing

This project welcomes contributions from everyone, with a focus on the UF Open Source Club community. Check out our Contributing Guide for:

  • How to get repository access - Join the development team
  • Branch naming conventions - Proper workflow practices
  • Issue guidelines - Working with bugs and features
  • Collaboration tips - Working with other contributors

The architecture prioritizes:

  • Simplicity - Easy to understand and modify
  • Extensibility - Straightforward to add new features
  • Cost Efficiency - Designed to run within AWS Free Tier
  • Best Practices - Following AWS and React patterns

For questions or issues, please refer to the documentation pages above or check the project's GitHub repository.

Clone this wiki locally