Postman Assistant is an open-source contact management system designed for field workers, couriers, and delivery personnel who need quick access to addresses without memorization. It allows users to search for names, emails, or phone numbers instantly while keeping records organized.
This is a project for collecting personal data. For sensitive data, there is a password, and it is encrypted in storage and decrypted on the fly.The current password is alshoja
. when u want to open in front end on form
This is a hobby project I created during my relocation to Berlin from India using Vue 3, Vuetify, and NestJS. The main use of this app will be aimed at POSTMAN in India, allowing them to store information about their area. It serves as a record-keeping tool for each person they interact with, functioning as an India Post record collector.
- 🔍 Smart Search – Find contacts easily using names, emails, or phone numbers.
- 📌 Location-Aware – Store and retrieve address data with geo-tagging.
- 📊 Data Export/Import – Easily transfer records in multiple formats (CSV, JSON, Excel). [PR WELCOMED]
- 🔐 Secure & Scalable – Role-based access and cloud-ready. [PR WELCOMED]
Make sure you have the following installed:
git clone https://github.com/your-username/posta-cloud.git
cd posta-cloud
Create a .env
file in the root directory and define the necessary environment variables:
POSTGRESQL_PORT=5432
POSTGRESQL_DATABASE=your_database
POSTGRESQL_USERNAME=your_user
POSTGRESQL_PASSWORD=your_password
VITE_API_URL=http://localhost:5000
VITE_ASSET_URL=http://localhost:3000
NODE_ENV=development
DB_HOST=posta_cloud_db
DB_PORT=5432
DB_NAME=your_database
DB_USER=your_user
DB_PASSWORD=your_password
PORT=5000
Run the following command to start all services:
docker-compose up --build
This will:
- Start a PostgreSQL database container (
posta_cloud_db
) - Start the backend service (
posta-cloud-be
) - Start the frontend service (
posta-cloud-fe
)
- Frontend: http://localhost:3000
- Backend API: http://localhost:5000
- Uses the Bitnami PostgreSQL image.
- Stores persistent data in a Docker volume
db-data
. - Initializes the database using scripts from
./database/
(if provided).
- Built with Vue 3 and Vuetify.
- Runs in development mode with
npm run dev
.
- A NestJS-based API service.
- Connects to the PostgreSQL database.
- Runs in development mode with
npm run start:dev
.
To stop and remove the containers, run:
docker-compose down
To view logs for a specific service, use:
docker-compose logs -f <service_name>
Example:
docker-compose logs -f backend
- Vue 3
- Vuetify
- Pinia
- NestJS
- PostgreSQL
- Docker
- Docker Compose
- The database uses a volume (
db-data
) to persist data across restarts. - Ensure that environment variables are correctly set in the
.env
file.
Help improve address management for field workers! If you're interested in contributing, feel free to fork this repo and submit your pull requests.