Skip to content

joao-pedrozo/condominiums

Repository files navigation

🏘️ Condominiums Dashboard

Condominium Dashboard Logo

You can click here to check the live version!

🛠️ Tech Stack

This project exemplifies a sophisticated condominium management dashboard, built with a focus on scalability, efficiency, and maintainability. The technologies and practices employed ensure clean code and a robust architecture.

The technologies used are:

  • ReactJS: Library for building dynamic user interfaces.
  • NextJS: React framework for server-side rendering and static site generation, with support for API communication via proxy.
  • TypeScript: JavaScript superset adding static typing.
  • Tailwind CSS: Utility-first CSS framework for efficient and responsive styling.
  • Shadcn UI: React component library offering modern and accessible UI.
  • React Hook Form: Library for form management and validation.

🚀 Features

  • Interactive Dashboard: Intuitive interface for effective condominium data management.
  • Dynamic Forms: Creation and editing of records with robust validation using React Hook Form.
  • Responsive Design: Optimized user experience across various devices using Tailwind CSS.
  • Reusable Components: Use of Shadcn UI to ensure a cohesive and high-quality interface.
  • Notifications and Alerts: Notification system to keep users informed about important events and updates.
  • API Communication via Proxy: Utilization of Next.js proxy feature for secure and efficient API integration.

🔧 Getting Started

To run the project locally, follow these steps:

Prerequisites

Make sure you have the following tools installed:

  • Git: Version control system.
  • Node.js: JavaScript runtime environment.
  • VSCode: Recommended code editor for more efficient development.

Running the Application

# Clone this repository

$ git clone https://github.com/joao-pedrozo/condominiums.git

# Navigate to the project directory

$ cd condominiums

# Install project dependencies

$ npm install

# or, if you prefer using Yarn

$ yarn

# Add the API_URL to the .env.local file

$ cp .env.sample .env.local

# Start the development server

$ yarn dev

About

Manage the condominiums of your company.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published