SiteSurveyor

SiteSurveyor is an open-source land surveying software developed by Eineva Inc. Designed specifically for regions with limited internet connectivity, SiteSurveyor provides offline functionality, secure data storage, and automated processing for professional surveyors, government agencies, and educational institutions. Supported on mobile (iOS and Android), desktop, and web platforms, SiteSurveyor makes surveying more accessible, efficient, and accurate.

---

Table of Contents

• Features
• Getting Started
• Installation
• Usage
• Technologies Used
• Contributing
• License
• Contact

---

Features

• Cross-Platform Support: Compatible with Android, iOS, desktop, and web.
• Offline Capability: Collect and store data offline with auto-sync once reconnected to the internet.
• Automated Data Processing: Automated calculations for slope, volume, elevation, and more.
• Secure Data Management: Data encryption, role-based access, and secure cloud storage.
• Multi-Format Export: Export reports in PDF, CSV, DXF, and DWG formats.
• Collaborative Development: Contributions from surveyors and developers worldwide.

---

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js (for frontend and mobile development): Install Node.js
• Python (for backend development): Install Python
• PostgreSQL (database): Install PostgreSQL
• Git: Install Git

Installation

Backend (Django)

1. Clone the repository:

   git clone https://github.com/YourUsername/SiteSurveyor.git
   cd SiteSurveyor/backend

2. Install Python dependencies:

   pip install -r requirements.txt

3. Configure the PostgreSQL database (update database credentials in settings.py), then migrate:

   python manage.py migrate

4. Run the server:

   python manage.py runserver

Frontend (React)

1. Navigate to the frontend directory:

   cd ../frontend

2. Install dependencies and start the development server:

   npm install
   npm start

Mobile (React Native)

1. Navigate to the mobile directory:

   cd ../mobile

2. Install dependencies:

   npm install

3. Start the mobile app:

   npm run start

---

Usage

• Desktop/Web: Navigate to the frontend URL displayed in the terminal after running the frontend server.
• Mobile: Use the Expo Go app (for development) to scan the QR code generated after starting the mobile app.
• Backend API: Visit http://127.0.0.1:8000 to access the Django backend API.

For more detailed usage instructions, please refer to the User Guide in the docs folder.

---

Technologies Used

• Backend: Django, Django REST Framework, PostgreSQL
• Frontend: React, Redux, Axios
• Mobile: React Native, Watermelon DB (for offline data)
• Data Synchronization: Watermelon DB, PostgreSQL
• Security: Data encryption, user authentication

---

Contributing

We welcome contributions from developers and surveyors to help improve SiteSurveyor!

To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m 'Add a feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request, describing your changes in detail.

Please read our CONTRIBUTING.md for more details on our code of conduct, coding style, and development workflow.

---

License

This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.

---

Contact

Eineva Inc.

• Email: admin@eineva.co.zw
• Website: https://eineva.co.zw

For questions or feedback, please open an issue or contact us directly.

---

Thank you for being part of the SiteSurveyor community!