Skip to content

README.md

Latest commit

 

History

History
114 lines (84 loc) · 3.96 KB

README.md

File metadata and controls

114 lines (84 loc) · 3.96 KB
Raw

🚀 Code-Cell-Website

License: Apache 2.0 Next.js Django Tailwind CSS Docker

Code-Cell-Website is a high-performance, vibrant platform built for the RCOE Code Cell community. It serves as a central hub for fostering creativity, collaboration, and coding excellence through events, interactive tutorials, and a passionate developer community.

✨ Key Features

  • 🔐 Advanced Authentication: Secure login with JWT, OTP-based registration, and seamless OAuth2 integration.
  • 📅 Event Management: Discover, track, and manage club events with real-time updates.
  • 👥 Team Showcase: Dynamic visualization of our Tech, Management, and Marketing teams.
  • 📱 QR Integration: Integrated QR code scanning and generation for event check-ins.
  • 🗺️ Interactive Maps: Built-in Leaflet integration for event locations.
  • 🎨 Premium UI/UX: Crafted with Next.js 15, Tailwind CSS, Framer Motion for animations, and Shadcn UI components.
  • 🐳 Containerized: Fully Dockerized for consistent development and deployment environments.

🛠️ Tech Stack

Frontend

Backend

DevOps & Tools

  • Containerization: Docker & Docker Compose
  • Security: SecretLint, detect-secrets, Pre-commit hooks
  • CI/CD: GitHub Actions ready

🚀 Getting Started

Prerequisites

  • Node.js (v18+)
  • Python (v3.10+)
  • Docker & Docker Compose (Optional but Recommended)

Option 1: Quick Start with Docker

docker-compose up --build

Access the frontend at http://localhost:3000 and the backend at http://localhost:8000.

Option 2: Manual Setup

1. Clone the repository

git clone https://github.com/RCOE-Code-Cell/Code-Cell-Website-.git
cd Code-Cell-Website-

2. Backend Setup

cd server
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver

3. Frontend Setup

cd ../client
npm install
npm run dev

📖 Documentation

  • API Endpoints: Detailed API documentation can be found in Endpoints.md.
  • Developer Guide: Comprehensive architectural overview and contribution guide in DEVELOPER.md.

🤝 Contributing

We welcome contributions! Please check our DEVELOPER.md for details on our code of conduct and the process for submitting pull requests.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📜 License

Distributed under the Apache License 2.0. See LICENSE for more information.

Made with ❤️ by the Code Cell Team