📍 Express Location

A Full-Stack Location Management System Built with MEAN Stack

---

📋 Table of Contents

• 🔍 Overview
• ✨ Features
• 🛠️ Tech Stack
• 🚀 Getting Started
  • 📋 Prerequisites
  • ⚙️ Installation
  • 🔧 Configuration
  • 🎯 Usage
• 📁 Project Structure
• 🔌 API Endpoints
• 🧪 Testing
• 🚀 Deployment
• 🤝 Contributing
• 📄 License

---

🔍 Overview

Express Location is a full-stack web application built with the MEAN stack (MongoDB, Express.js, Angular, Node.js) that provides comprehensive location management functionality. This project demonstrates modern web development practices with a robust backend API and an interactive frontend interface.

🎯 Purpose

This application serves as a complete solution for:

• Location data management
• Geographic information processing
• Real-time location tracking
• User-friendly location visualization

---

✨ Features

🗺️ Core Functionality

• Location Management: Create, read, update, and delete location data
• Geographic Search: Find locations by various criteria
• Real-time Updates: Live location tracking capabilities
• Interactive Maps: Visual representation of location data
• Data Validation: Robust input validation and error handling

🔐 Security & Performance

• Authentication & Authorization: Secure user management
• Data Encryption: Protected sensitive information
• Optimized Queries: Efficient database operations
• Caching: Improved response times
• Error Handling: Comprehensive error management

---

🛠️ Tech Stack

Backend

• Runtime:
• Framework:
• Database:
• ODM: Mongoose for MongoDB object modeling

Frontend

• Framework:
• Styling: CSS3 with responsive design
• HTTP Client: Angular HttpClient for API communication

Additional Tools

• Package Manager:
• Version Control:

---

🚀 Getting Started

📋 Prerequisites

Before running this project, make sure you have the following installed:

• Node.js (v14.0.0 or higher)
• npm (v6.0.0 or higher)
• MongoDB (v4.0.0 or higher)
• Angular CLI (v12.0.0 or higher)

# Check your versions
node --version
npm --version
mongo --version
ng version

⚙️ Installation

1. Clone the repository

git clone https://github.com/v9dev/epresslocation.git
cd epresslocation

2. Install backend dependencies

# Install server dependencies
npm install

3. Install frontend dependencies

# Navigate to client directory (if separate)
cd client
npm install
cd ..

🔧 Configuration

1. Environment Variables Create a .env file in the root directory:

# Server Configuration
PORT=3000
NODE_ENV=development

# Database Configuration
MONGODB_URI=mongodb://localhost:27017/expresslocation
DB_NAME=expresslocation

# JWT Configuration
JWT_SECRET=your_jwt_secret_key
JWT_EXPIRE=7d

# API Keys (if using external services)
GOOGLE_MAPS_API_KEY=your_google_maps_api_key

2. Database Setup

# Start MongoDB service
sudo service mongod start

# Or using Docker
docker run -d -p 27017:27017 --name mongodb mongo:latest

🎯 Usage

1. Start the development server

# Start backend server
npm run dev

# Start frontend (in separate terminal)
cd client
ng serve

2. Access the application

• Frontend: http://localhost:4200
• Backend API: http://localhost:3000
• API Documentation: http://localhost:3000/api-docs

---

📁 Project Structure

epresslocation/
├── 📁 config/                 # Configuration files
│   ├── database.js            # Database configuration
│   └── auth.js               # Authentication config
├── 📁 controllers/            # Route controllers
│   ├── locationController.js  # Location operations
│   └── authController.js     # Authentication logic
├── 📁 models/                 # Database models
│   ├── Location.js           # Location schema
│   └── User.js               # User schema
├── 📁 routes/                 # API routes
│   ├── locations.js          # Location routes
│   └── auth.js               # Authentication routes
├── 📁 middleware/             # Custom middleware
│   ├── auth.js               # Authentication middleware
│   └── validation.js         # Input validation
├── 📁 client/                 # Angular frontend
│   ├── 📁 src/
│   │   ├── 📁 app/
│   │   ├── 📁 assets/
│   │   └── 📁 environments/
│   └── package.json
├── 📁 tests/                  # Test files
├── 📁 docs/                   # Documentation
├── .env                       # Environment variables
├── .gitignore                # Git ignore file
├── package.json              # Node.js dependencies
├── server.js                 # Main server file
└── README.md                 # Project documentation

---

🔌 API Endpoints

Authentication

POST   /api/auth/register      # User registration
POST   /api/auth/login         # User login
GET    /api/auth/profile       # Get user profile
PUT    /api/auth/profile       # Update user profile

Locations

GET    /api/locations          # Get all locations
GET    /api/locations/:id      # Get location by ID
POST   /api/locations          # Create new location
PUT    /api/locations/:id      # Update location
DELETE /api/locations/:id      # Delete location

Search & Filter

GET    /api/locations/search?q=query     # Search locations
GET    /api/locations/nearby?lat=&lng=   # Find nearby locations
GET    /api/locations/filter?category=   # Filter by category

Example API Response

{
  "success": true,
  "data": {
    "_id": "60d5ecb74b24a1b2c8d4e6f7",
    "name": "Central Park",
    "coordinates": {
      "latitude": 40.785091,
      "longitude": -73.968285
    },
    "category": "park",
    "description": "A large public park in Manhattan",
    "createdAt": "2024-06-17T10:30:00.000Z"
  }
}

---

🧪 Testing

Run Tests

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run specific test file
npm test -- --grep "location"

Test Structure

tests/
├── unit/                    # Unit tests
│   ├── controllers/        # Controller tests
│   └── models/            # Model tests
├── integration/           # Integration tests
└── e2e/                  # End-to-end tests

---

🚀 Deployment

Production Build

# Build frontend for production
cd client
ng build --prod

# Start production server
npm run start:prod

Environment Setup

# Set environment variables for production
export NODE_ENV=production
export MONGODB_URI=your_production_db_uri
export JWT_SECRET=your_production_jwt_secret

Docker Deployment

# Dockerfile example
FROM node:16-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
EXPOSE 3000
CMD ["npm", "start"]

---

🤝 Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Commit your changes

   git commit -m 'Add some amazing feature'

4. Push to the branch

   git push origin feature/amazing-feature

5. Open a Pull Request

Development Guidelines

• Follow the existing code style
• Write tests for new features
• Update documentation as needed
• Ensure all tests pass before submitting

---

📄 License

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

---

🌟 Show Your Support

Give a ⭐ if this project helped you!

📞 Contact

Developer: v9dev
Repository: epresslocation

---

⬆️ Back to top