An open API service indexing awesome lists of open source software.

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

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

drizzle-orm gcp github-actions mongoose monorepo nextjs postgresql shadcn-ui tailwindcss turborepo typescript

Last synced: about 2 months ago
JSON representation

Monorepo for college ecosystem project

Awesome Lists containing this project

README

        

# College Ecosystem

[![๐Ÿงน Lint project](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/lint-project.yml/badge.svg)](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/lint-project.yml)
[![๐Ÿš€ Deployments](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/deploy.yml/badge.svg)](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/deploy.yml)
[![CodeQL](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/github-code-scanning/codeql)
[![Dependabot Updates](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/kanakkholwal/college-ecosystem/actions/workflows/dependabot/dependabot-updates)

**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)

## 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 SQL with Drizzle ORM
- **Build Tools**: Turbo
- **Other**: Docker, ESLint, Prettier (Biome on local), 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.