Propdock

Start at full speed with Propdock !

Introduction · Installation · Tech Stack + Features · Author · Credits

Introduction

Welcome to Propdock, where we're revolutionizing property management and real estate analytics. Our platform offers comprehensive solutions for monitoring, tracking, and analyzing property-related data in real-time. Whether you're a property manager, real estate investor, or developer, Propdock provides the tools you need to make informed decisions and optimize your property portfolio.

Key features of Propdock include:

• Real-time property monitoring
• Event tracking for property-related activities
• Advanced data analytics for real estate insights
• Integration with various property management tools
• Customizable dashboards for at-a-glance information

With Propdock, you'll have all the information you need at your fingertips to streamline your property management processes and maximize your real estate investments.

Directory Structure

Propdock is a monorepo managed by Turborepo. The monorepo is split between apps and packages directories.

.
├── apps                         # Its app workspace which contains
│    ├── www                     # Nextjs app which is deployed in Vercel
│    ├── api                     # Hono app that is our REST-api for our SDK
│    └── ...
├── packages                     # are the shared packages that are used by the apps 
│    ├── db                      # Prisma DB connector
│    └── ui                      # Shared UI components (Shadcn)
├── tooling                      # are the shared configuration that are used by the apps and packages
│    ├── eslint                  # Shared eslint presets
│    ├── prettier                # Shared prettier configuration
│    ├── tailwind                # Shared tailwind configuration
│    └── typescript              # Shared tsconfig you can extend from
├── LICENSE
└── README.md

Installation

Clone & create this repo locally with the following command:

git clone https://github.com/Codehagen/Propdock

1. Install dependencies using pnpm:

pnpm install

2. Copy .env.example to .env.local and update the variables.

cp .env.example .env.local

4. Input everything you need for the env.

   1. Create Neon Database Account
   2. Create Stripe Account
   3. Create Google Console Account
   4. Create Resend Account

5. Start the development server from either yarn or turbo:

# To start the server
pnpm dev

# To push the DB schema
pnpm --filter=db db:push

REST-API Installation (optinal)

If you want to use the REST-api you need to update the hono under apps/api

[vars]
#MY_VAR = "my-variable"
#DATABASE_URL = "Use same link as your db URL"

If you want to deploy it on Cloudflare you need to go run

pnpm run deploy

Tech Stack + Features

Frameworks

• Next.js – React framework for building performant apps with the best developer experience
• Auth.js – Handle user authentication with ease with providers like Google, Twitter, GitHub, etc.
• Prisma – Typescript-first ORM for Node.js
• React Email – Versatile email framework for efficient and flexible email development

Platforms

• Vercel – Easily preview & deploy changes with git
• PlanetScale – A cutting-edge database platform for seamless, scalable data management
• Resend – A powerful email framework for streamlined email development

Contributing

We love our contributors! Here's how you can contribute:

• Open an issue if you believe you've encountered a bug.
• Make a pull request to add new features/make quality-of-life improvements/fix bugs.

Repo Activity