Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berkozkancsgod/topratek
A data visualization tool for farmers using satellite maps
https://github.com/berkozkancsgod/topratek
mapbox mapbox-gl-draw mapbox-gl-js mongodb nodejs pug pug-template-engine
Last synced: 29 days ago
JSON representation
A data visualization tool for farmers using satellite maps
- Host: GitHub
- URL: https://github.com/berkozkancsgod/topratek
- Owner: berkOzkanCSGod
- Created: 2024-01-17T19:48:18.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-01-28T13:42:55.000Z (10 months ago)
- Last Synced: 2024-10-10T23:01:33.907Z (29 days ago)
- Topics: mapbox, mapbox-gl-draw, mapbox-gl-js, mongodb, nodejs, pug, pug-template-engine
- Language: JavaScript
- Homepage:
- Size: 328 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TopraTek: Farmer's Mapping Tool
Demo video: https://youtu.be/rBc-QGZwgxE
[Technical Details (for employers)](#technical-details)
*** Contact berk[[dot]]ozkan[[at]]ug[[dot]]bilkent[[dot]]edu[[dot]]tr for demo with working api keys ***
Welcome to TopraTek! This project aims to provide a comprehensive mapping solution tailored specifically for farmers. With this application, farmers can easily outline their land, label it, categorize locations, and record additional data such as current crop and crop planting history. Whether you're a small-scale farmer or managing large agricultural operations, this tool is designed to streamline your mapping and data recording processes.
## Features
### Land Outlining
- Easily outline and define the boundaries of your land using intuitive drawing tools.
- Precisely mark specific areas, fields, or plots for detailed management.
- Edit changes later
### Labeling and Categorization
- Add labels to different areas of your land to identify specific features such as crops, buildings, water sources, etc.
- Categorize locations based on various attributes like soil type, terrain features, irrigation methods, etc.
### Crop Management
- Record and track information about the current crop planted in each area of your land.
- Maintain a history of crop rotations and planting schedules for better crop management practices.
### Data Visualization
- Visualize your land and all associated data on an interactive map for easy reference and analysis.
- Gain insights into your farming operations by overlaying different layers of information.
### Getting Started
```diff
@@ This won't work since I removed API and DB Keys @@
```
To get started with TopraTek, follow these steps:
1. Pull repo
2. Navigate to TopraTek folder
```
cd TopraTek (or TopraTekv3)
```
```
cd src
```
3. Install dependencies
```
npm install
```
4. Run
```
npm run start
```
5. Go to localhost:3000/login on your browser and use.
Implemented:
- Authentication via tokens
- Routing
- Frontend-backend communication (MVC)
- backend-database communication (MVC)
- Frontend-Mapbox API communication
- Serverside rendering with PUG and Node JS
- Dynamic component rendering with fetch await promises
- Drawing shapes on the map
- OOP for user structure in MongoDB
- Unit tests
1. Utilization of UML for Project Design and Planning:
I used Unified Modeling Language (UML) to plan and design this project. This involved creating diagrams to visualize the project's structure, how they relate to each other, and what they do. Using UML helped me organize the project in a clear and structured way, showing my ability to plan software projects thoughtfully.
2. Embracing Vanilla JavaScript:
I deliberately chose to use vanilla JavaScript and Node JS for this project. Instead of relying on frameworks or libraries, I wanted to understand how JavaScript and frontend-backend interactions work from the ground up. This hands-on approach allowed me to dive into core concepts, learning their details and best practices thoroughly. By doing so, I'm better equipped to handle various challenges in web development and beyond.
** Personal anecdote **
When developing this project I ran into a performance problem. I wanted to update features, such as the sidebar and map live when a user added a location, however, since PUG is a serverside template engine each change required a complete reload of the page. Then, I discovered HTMX, which helped me make some parts dynamic without reloading the page–greatly increasing performance. However, some feature updates required a more tailored approach (or I didn't know htmx well enough), so this led me to do routing and updating manually with vanilla JS fetch and awaits on the frontend. And so, I was able to benefit from the superior performance of server-side rendering while keeping the site dynamic.
In summary, this project reflects my commitment to learning and mastering software development techniques. It demonstrates my ability to plan projects systematically.
### Tools
- Node JS v21.2.0
- PUG (formerly jade)
- HTML/CSS/JS
- Mapbox
- Express
- MongoDB
## UML
### Use Case Diagram
### Sequence Diagram (all combined into one for easy reading)
I didn't add (due to time constraints):
- Error indicators
- Editing geometric shapes on the map
- Weather data with OpenWeatherAPI
- Full-screen mode
- View settings
- Navigation on map
- Some details
- Could spend more time on input-checking