https://github.com/kanakkholwal/college-ecosystem

Monorepo for college ecosystem project
https://github.com/kanakkholwal/college-ecosystem

mongoose monorepo nextjs shadcn-ui tailwindcss turborepo typescript

Last synced: 9 days ago
JSON representation

Monorepo for college ecosystem project

• Host: GitHub
• URL: https://github.com/kanakkholwal/college-ecosystem
• Owner: kanakkholwal
• Created: 2024-06-17T14:16:25.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-05T11:21:01.000Z (4 months ago)
• Last Synced: 2024-08-05T19:09:45.519Z (4 months ago)
• Topics: mongoose, monorepo, nextjs, shadcn-ui, tailwindcss, turborepo, typescript
• Language: TypeScript
• Homepage: https://nith.eu.org
• Size: 3.51 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# College Ecosystem

[![Trigger Deployments](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/deploy.yml)

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](#features)

- [Project Structure](#project-structure)

- [Tech Stack](#tech-stack)

- [Deployment](#deployment)

- [Contributing](#contributing)

- [License](#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

```bash

/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](.github/workflows/deploy.yml).

## Contributing

We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for more details.