College Ecosystem

College Ecosystem is a monorepo for various projects aimed at creating a comprehensive platform for managing and interacting with different aspects of a college environment. It includes frontend applications built with Next.js and a backend server using Express and TypeScript.

Table of Contents

• Features
• Project Structure
• Tech Stack
• Deployment
• Contributing
• License

Features

• Platform: A Next.js application for the main platform.
• Website: A Next.js application for the college website.
• Server: An Express server with TypeScript for backend operations.
• Modular Architecture: Scalable and maintainable project structure.

Project Structure

/college-ecosystem
  /apps
    /platform      # College Platform (app.nith.eu.org)
    /website       # Website          (nith.eu.org)
  /turbo.json      # Turbo Repo configuration
  /package.json    # Root package.json with Yarn workspaces configuration
  /.gitignore      # Git ignore file
  /README.md       # This readme file

Tech Stack

• Frontend: Next.js, React, TypeScript
• Backend: Express, TypeScript, Node.js
• Database: MongoDB with mongoose,Upstash Redis, Postgres (will use)
• Build Tools: Turbo
• Other: Docker, ESLint, Prettier, Jest

Deployment

GitHub Actions

We use GitHub Actions to automate the deployment process for both Vercel and Docker, deploy.

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for more details.