Circle is a modern, full-stack monorepo application designed to provide a seamless social experience. It leverages a robust architecture comprising a high-performance backend and a dynamic, responsive frontend.

This repository serves as the ROOT monorepo, housing all sub-projects and shared resources necessary for the development, deployment, and maintenance of the Circle platform.

• Unified Monorepo Workflow: Centralized management of frontend and backend codebases.
• Modern Tech Stack: Built with TypeScript, React, Node.js, and Prisma.
• Scalable Architecture: Designed for modularity and ease of extension.

This repository is organized as a monorepo, facilitating code sharing and unified versioning across different parts of the application.

circle/
├── .git/                 # Git configuration
├── be-circle/            # Backend API (Node.js/Express, Prisma)
├── fe-circle/            # Frontend Application (React, Vite)
├── ARCHITECTURE.md       # System architecture documentation
├── CHANGELOG.md          # Version history
├── CODE_OF_CONDUCT.md    # Community standards
├── CONTRIBUTING.md       # Contribution guidelines
├── GOVERNANCE.md         # Project governance
├── LICENSE               # License information
├── README.md             # This file
├── ROADMAP.md            # Future plans
├── SECURITY.md           # Security policies
└── SUPPORT.md            # Support channels

The Circle platform consists of the following primary sub-projects:

The server-side application responsible for API handling, database interactions, and authentication.

• Tech Stack: Node.js, Express, TypeScript, Prisma, PostgreSQL, Redis, Cloudinary.
• Location: ./be-circle

The client-side application providing the user interface and user experience.

• Tech Stack: React, Vite, TypeScript, Chakra UI, Redux Toolkit.
• Location: ./fe-circle

To get a local copy of the project up and running, follow these simple steps.

• Node.js (v18 or higher)
• npm or yarn
• PostgreSQL (Local or hosted instance)
• Redis (Optional, for caching features)

1. Clone the repository

   git clone https://github.com/MDF05/circle.git
   cd circle

2. Install Dependencies Refer to the individual sub-project READMEs for specific installation instructions.

   • Backend Setup Guide
   • Frontend Setup Guide

This section serves as the central navigation hub for all project documentation. Please refer to the specific documents below for detailed information.

• ARCHITECTURE.md - Deep dive into the system design, boundaries, and communication.
• ROADMAP.md - Future features and milestones.
• CHANGELOG.md - History of changes and versions.

• GOVERNANCE.md - How the project is governed and decisions are made.
• CONTRIBUTING.md - Comprehensive guide for contributors.
• CODE_OF_CONDUCT.md - Standards for community behavior.

• LICENSE - The ISC License governing this software.
• SECURITY.md - Security policy and vulnerability reporting.
• DISCLAIMER.md - Legal disclaimer and liability limitations.

• SUPPORT.md - Where to find help and ask questions.

• Backend Documentation
• Frontend Documentation

We welcome contributions! Please follow our standard process:

1. Read the Contribution Guidelines.
2. Check for open issues or open a new one to discuss a feature/bug.
3. Fork the repository and create your branch (git checkout -b feature/AmazingFeature).
4. Commit your changes (git commit -m 'Add some AmazingFeature').
5. Push to the branch (git push origin feature/AmazingFeature).
6. Open a Pull Request.

We take security seriously. If you discover a vulnerability, please do NOT open a public issue. Review our Security Policy for instructions on how to report it safely.

Distributed under the ISC License. See LICENSE for more information.

• Circle Team - Initial Work

Project Link: https://github.com/MDF05/circle