Welcome to the Circle Frontend repository. This is the web client for the Circle social platform, built with modern web technologies to provide a fast, responsive, and interactive user experience.
This README serves as the central hub for all documentation. Please refer to the specific documents below for detailed information.
- Architecture: Project structure, state management, and component design.
- Style Guide: Coding standards, component naming, and styling conventions.
- Environment Variables: Configuration reference for
.envfiles. - Deployment: Build instructions, previewing, and Vercel deployment.
- Testing: Linting and testing strategies.
- Contributing: Workflow for submitting pull requests.
- Code of Conduct: Community standards and expectations.
- Support: How to get help.
- Changelog: History of changes and releases.
- Roadmap: Future plans and upcoming features.
- Disclaimer: Liability and warranty information.
- License: Legal usage terms.
- Node.js: v18+ (Recommended)
- npm or yarn
-
Clone the repository
git clone https://github.com/MDF05/circle-frontend.git cd circle-frontend -
Install dependencies
npm install
-
Configure Environment Copy
.env.exampleto.envand fill in the required values (mainly API URL).cp .env.example .env
See ENVIRONMENT.md for details.
Start the development server with hot module replacement (HMR):
npm run devThe application will usually be available at http://localhost:5173.
To create an optimized production build:
npm run buildThis will generate static assets in the dist/ directory.
To preview the production build locally:
npm run preview- Core: React, TypeScript, Vite
- State Management: Redux Toolkit
- Styling: Chakra UI, Tailwind CSS
- Animations: Framer Motion
- Forms: React Hook Form, Zod
- Routing: React Router
- HTTP Client: Axios
This project is licensed under the ISC License. See the LICENSE file for details.