Skip to content

Commit

Permalink
updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
suxrobGM committed Oct 6, 2024
1 parent 2670470 commit 0cec93c
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Logistics TMS primarily targets logistics and trucking companies seeking to stre
Operating on a multi-tenant architecture, Logistics TMS features a primary database for storing user credentials and tenant data, including company name, subdomain name, database connection string, and billing periods. Each tenant or company has a dedicated database.

## Development status
The project is actively under development. I have completed 85% of the work required for the first version of the MVP.
I work on this project in my free time so it is not actively maintained. However, I am open to collaboration and contributions. If you are interested in contributing to this project, please feel free to reach out to me at **[email protected]** or [Telegram](https://t.me/suxrobgm).

## Getting Started

Follow these steps to get the project up and running:

1. Install SDKs
- [Download](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) and install the .NET 8 SDK.
- [Download](https://nodejs.org) and install the Node.js runtime.
- Install Bun runtime to run Angular project. Follow [these](https://bun.sh/docs/installation) instructions.

2. Clone this repository:
```
Expand Down Expand Up @@ -59,13 +59,6 @@ Follow these steps to get the project up and running:
- Admin app: https://127.0.0.1:7002
- Office app: https://127.0.0.1:7003

## Demo application
The sample deployed application is available at http://office.jfleets.com

User email: [email protected]

User password: Test12345#

## Architectural Overview

### Technical Stack
Expand All @@ -86,6 +79,7 @@ User password: Test12345#
- SignalR
- Docker
- CI/CD
- Bun

### Design Patterns
- Multi-Tenant Architecture
Expand Down

0 comments on commit 0cec93c

Please sign in to comment.