Real Logistics App

Welcome to our Logistics App! 🚚

This application simplifies logistics operations by providing real-time tracking and management features. Whether you're managing deliveries, tracking shipments, this app has got you covered!

Features

• Real-time Tracking: Keep track of your shipments and deliveries in real-time, ensuring efficient management and monitoring.
• Authentication: Secure your application with user authentication, ensuring that only authorized users can access sensitive features and data.
• Live Rider Position Updates: Track the position of riders in real-time, providing both senders and receivers with accurate updates on delivery progress.
• Efficient Routing: Optimize routes to minimize delivery times and costs, improving overall efficiency and customer satisfaction.
• Intuitive UI: User-friendly interface designed with simplicity and ease of use in mind, ensuring a seamless experience for all users.
• Traffic Route: Coming soon.

Technologies Used

• Node.js: A powerful JavaScript runtime used for building scalable and efficient server-side applications.
• TypeScript: TypeScript adds static typing to JavaScript, making our codebase more robust and maintainable.
• Socket.IO: Enables real-time, bidirectional communication between clients and servers, perfect for live updates and notifications.
• PostgreSQL: A powerful open-source relational database system used for storing and managing data related to shipments, deliveries, and more.
• Docker: Docker containers make deployment easy and consistent across different environments, ensuring smooth deployment and scalability.

Installation

To get started with our Logistics App, follow these steps:

1. Clone the Repository:

   git clone https://github.com/Simplecodez/Real-Logistics.git
   cd Real-Logistics
   

2. Install Dependencies: npm install

3. Set Up Environment Variables: Create a .env file in the root directory. Add environment variables such as database credentials, API keys, etc. Example

   APP_NAME
   NODE_ENV
   POSTGRESQL_CONNECTION_UR
   EMAIL_PASSWORD
   EMAIL
   JWT_SECRET
   GEOLOCATION_API
   GEOLOCATION_API_KEY
   JWT_EXPIRES_IN
   JWT_COOKIE_EXPIRES_IN
   

4. Build your Typescript: npm run build

5. Start your server: npm start

6. Access the App: Open your browser and navigate to https://real-logistics.onrender.com to access the Real Logistics App.

7. API Documentation: For detailed API documentation and examples, please refer to our Postman Documentation

8. Contributing: We welcome contributions from the community! If you'd like to contribute to our project, please follow these guidelines:

   • 1. Fork the repository and create a new branch for your feature or bug fix.
   • 2. Make your changes and ensure all tests pass.
   • 3. Submit a pull request describing your changes and their rationale.