Skip to content

Commit

Permalink
Readme.md Updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Ajmain-Fayek committed Jan 22, 2025
1 parent be111a6 commit f3ee8dd
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

StructoMate is a comprehensive building management application designed to simplify managing tenants, agreements, announcements, payments, and more in a single-building environment.

---

## Features

- **User Management**: Add, update, and manage users and their roles (admin, member, user).
Expand All @@ -11,16 +13,13 @@ StructoMate is a comprehensive building management application designed to simpl
- **Announcements**: Post and retrieve announcements for users, members, or both.
- **Apartments**: View available apartments and their details.

---

## Client Side

- [Live Demo](https://structomate.web.app/)

## Installation

### Prerequisites

- Node.js (v14 or higher)
- MongoDB (local or cloud instance)
---

## API Endpoints

Expand Down Expand Up @@ -71,6 +70,8 @@ StructoMate is a comprehensive building management application designed to simpl
- **POST** `/api/users/:email`: Get user data by email (requires JWT).
- **POST** `/api/users`: Create a new user.

---

## Folder Structure

```
Expand All @@ -87,6 +88,15 @@ root
└── vercel.json
```

---

## Installation

### Prerequisites

- Node.js (v14 or higher)
- MongoDB (local or cloud instance)

### Steps

1. Clone the repository:
Expand Down Expand Up @@ -122,12 +132,16 @@ root

5. Open the app in your browser at `http://localhost:<port>`.

---

## Usage

- Admins can manage users, agreements, and announcements.
- Members can view and accept agreements, make payments, and view announcements.
- The app provides a dashboard for easy navigation and management.

---

## Tech Stack

- **Frontend**: React.js, TailwindCSS
Expand All @@ -136,6 +150,8 @@ root
- **Authentication**: JWT (JSON Web Tokens)
- **Payment Integration**: Stripe

---

## Contributing

We welcome contributions! Please follow these steps:
Expand All @@ -146,6 +162,8 @@ We welcome contributions! Please follow these steps:
4. Push to the branch: `git push origin feature-name`.
5. Open a pull request.

---

## License

This project is licensed under the MIT License. See the LICENSE file for details.

0 comments on commit f3ee8dd

Please sign in to comment.