Skip to content

haybarcheezy/terraconnect

Repository files navigation

TerraConnect

TerraConnect is a full-stack land management application powered by Django, Django Rest Framework (DRF), and Next.js. It employs Tailwind CSS and Tailwind UI for stylish and responsive UI/UX. Docker and Docker Compose are used for easy setup and deployment. Alt text Alt text Alt text

Table of Contents

  1. Features
  2. Installation
  3. Usage
  4. Contributing
  5. Support
  6. License

Features

  • Comprehensive land management tools
  • Sleek, modern UI built with Tailwind CSS and Tailwind UI
  • Backend powered by Django and Django Rest Framework (DRF)
  • Next.js frontend for optimized user interface
  • Easy setup and deployment with Docker
  • Bulk CSV properties upload
  • Property search and filtering
  • Photo upload and storage
  • Property detail page with Google Maps integration (TODO)
  • Property analytics (TODO)
  • Property reports (TODO)
  • Property S3 file storage (TODO)
  • Property notifications (TODO)

Installation

Make sure Docker and Docker Compose are installed on your machine. Then, follow these steps:

  1. Clone the repository:

    git clone https://github.com/haybarcheezy/TerraConnect.git
    cd TerraConnect
  2. Build and run the Docker services:

    docker-compose up -d
  3. After the services are up, create the necessary database migrations:

    docker-compose exec web python manage.py makemigrations
    docker-compose exec web python manage.py migrate

For the frontend:

  1. Navigate to the frontend directory:

    cd frontend
  2. Install all dependencies:

    npm install

Usage

Once everything is set up:

  • Start the backend server with Docker Compose:

    docker-compose up -d
  • Start the frontend development server:

    cd frontend
    npm run dev

Now, you can navigate to http://localhost:3000 (or the port you've configured) in your browser to start using TerraConnect.

Contributing

We welcome contributions! Please see our Contributing Guidelines for more details.

Support

If you encounter any issues or have questions, please file an issue in our GitHub issue tracker.

License

TerraConnect is open source and MIT licensed.

About

TerraConnect is a full-stack land management application powered by Django, Django Rest Framework (DRF), and Next.js. It employs Tailwind CSS and Tailwind UI for stylish and responsive UI/UX. Docker and Docker Compose are used for easy setup and deployment.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors