Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pedroramos17 committed Oct 1, 2024
1 parent 09082ce commit fca8bea
Showing 1 changed file with 65 additions and 45 deletions.
110 changes: 65 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,82 @@
# Property Management System
# Barkin: Next-Gen Property Management System (Alpha)

This is a demo Property Management System working as offline-first app.
Barkin is an innovative, offline-first Property Management System in development, designed to revolutionize how businesses handle their properties, bookings, and customer interactions. Built with modern web technologies, Barkin aims to offer unparalleled reliability and ease of use for enterprise sites with high people flow.

[See the preview](https://demo-barkin-pedroramos17.vercel.app/)
## Tools
* React.js
* Next.js
* Redux Toolkit
* Material-UI
πŸš€ [Live Demo](https://demo-barkin-pedroramos17.vercel.app/)

## To-do
Offline-First Architecture: Ensure uninterrupted operations, even without internet connectivity.

- [ ] Rooms
- [ ] Availability & Rating System
- [ ] Services
- [ ] Facilities
- [ ] Tickets
- [ ] Products
- [ ] Notifications
- [ ] Authentication
- [ ] Authorization
- [ ] Background-Sync
Progressive Web App (PWA): Deliver a native app-like experience across all devices.

## Done
Comprehensive Management: Handle properties, reservations, orders, and customer data effortlessly.

Powerful Search: Quickly find the information you need with our full-text search capability.

- [X] ~~CRUD customers~~
- [X] ~~Full-text search~~
- [X] ~~Add global state (RTK)~~
- [X] ~~Booking~~
- [X] ~~Orders~~
- [X] ~~Export report in PDF/Spreadsheet~~
- [X] ~~Properties~~
Flexible Reporting: Export custom reports in PDF format for in-depth analysis.

## Getting Started
## 🎯 Who It's For

First, install the dependencies:
Corporate Offices: Streamline visitor management and meeting room bookings.

```bash
npm i
# or
yarn
# or
pnpm i
# or
bun install
```
Educational Institutions: Manage dorms, classrooms, and event spaces efficiently.

Healthcare Facilities: Optimize patient room assignments and equipment tracking.

Government Buildings: Enhance security and space utilization with advanced tracking.

## πŸ’» Tech Stack

React.js & Next.js for a robust, server-side rendered frontend

Redux Toolkit for efficient state management

Material-UI for a sleek, responsive design

## πŸ›£οΈ Development Roadmap
We're working hard to bring you a game-changing property management solution. Here's what we're focusing on:

After, run the development server:
### βœ… Completed:

* CRUD operations for customers
* Full-text search functionality
* Global state management with Redux Toolkit
* Basic booking system
* Order management
* Report export (PDF)

### 🚧 In Progress (Alpha Release):

* Property management
* Room management
* Availability & rating system
* Services and facilities management
* Ticketing system for maintenance requests
* Product inventory
* Notifications
* Authentication and authorization
* Background sync for offline-first functionality

## πŸš€ Getting Started (For Developers)
```bash
# Clone the repository
git clone https://github.com/yourusername/barkin.git

# Install dependencies
npm install

pnpm install

# Run the development server
npm run dev
# or
yarn dev
# or

pnpm dev
# or
bun dev

# Open http://localhost:3000 in your browser
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## πŸ‘¨β€πŸ’» Contribute
Barkin is an open-source project, and we welcome contributions from the community. Whether you're fixing bugs, improving documentation, or proposing new features, your efforts are appreciated.

πŸ› Report issues

πŸ”€ Submit pull requests

0 comments on commit fca8bea

Please sign in to comment.