Skip to content

Latest commit

 

History

History
129 lines (96 loc) · 5.47 KB

README.md

File metadata and controls

129 lines (96 loc) · 5.47 KB

Tu AppMinistrador

HeaderAppMinistrador-min

Overview

This web application is the culmination of a collaborative effort between the full stack development bootcamp students at The Bridge and the UX team, aimed at solving the challenges faced by the Colegio de Administradores de Fincas de VLC-CAS. It's designed to streamline task management and organizational aspects of community management.

Table of Contents

Features

  1. Authentication: Implemented Auth0 for secure user authentication.
  2. CRUD Operations: Enabled Create, Read, Update, and Delete operations for both incidences and communities.
  3. HTTP Requests: Incorporates Axios for efficient and promise-based HTTP requests to connect the frontend and backend.
  4. Mobile-First and SPA: Developed as a mobile-first and single-page application (SPA) to ensure smooth user interaction without page reloads.
  5. React and Redux: Utilized React for the frontend and implemented state management with Redux.
  6. Ant Design: Integrated Ant Design components to enhance the UI and user experience.
  7. MVC Architecture: Followed the Model-View-Controller architecture for a structured and scalable codebase.
  8. React Router: Implemented React Router for seamless navigation within the SPA.

Technologies Used

  • Frontend:

    • react
    • javascript
    • Redux
    • React Router
    • sass

  • Ant Design

  • Backend:

  • Authentication:

    • Auth0

  • Others:

    • MVC Architecture
    • Mobile-First Design

Getting Started

To get started with the project, follow the instructions below.

Installation

  1. Clone the repository 
    git clone https://github.com/Cocera/DT2024_client.git
cd DT2024_client
  2. Switch to the relevant branch 
    git checkout [your-branch-name]
  3. Install dependencies 
    npm install
  4. Start the application 
    npm start
    This will run the app in the development mode. Open http://localhost:5173 to view it in the browser. Make sure you have Node.js installed on your machine before running these commands.

Backend

https://github.com/frances0688/DT2024_server.git

Contributing

Contributions are welcomed and appreciated! Your input helps us create a better community and enhance the Tu AppMinistrador project.

If you have suggestions, bug fixes, or new features to propose, here's how you can contribute:

  1. Fork the Repository Click the "Fork" button on the top right of the repository's page to create your copy.

  2. Create a Feature Branch

  git checkout -b feature/YourName

Create a branch with a descriptive name for your contribution.

  1. Commit Your Changes
  git commit -m 'Add some YourName'

Make your changes and commit them with a clear and concise message.

  1. Push to the Branch
 git push origin feature/YourName

Push your changes to your branch on your forked repository.

  1. Open a Pull Request. Go to the original repository and click on "New Pull Request". Describe your changes and submit the pull request.

If you have a suggestion that would make this better, please fork the repo and create a pull request. Please tag it as "enhancement". Don't forget to give the project a star if you found it helpful! Your support means a lot.

Thank you for contributing to Tu AppMinistrador!

Acknowledgments

Thanks to Colegio de Administradores de Fincas de VLC-CAS for the opportunity. Appreciation to The Bridge for the Full Stack Development Bootcamp.

Team

© [2024] [The Bridge Talent Accelerator | Full-Stack Development Bootcamp 2023-2024]