{"id":31588577,"url":"https://github.com/sudoerr/odyssey","last_synced_at":"2026-05-01T12:32:20.455Z","repository":{"id":315261149,"uuid":"1058750188","full_name":"sudoerr/odyssey","owner":"sudoerr","description":"Transform the ESP32 into a lightweight file drive server with an integrated WebApp on a Micro SD card.","archived":false,"fork":false,"pushed_at":"2026-01-24T19:17:48.000Z","size":3983,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-25T08:14:49.515Z","etag":null,"topics":["arduino","esp32","esp32-arduino","file-sharing","webapp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sudoerr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-17T13:55:05.000Z","updated_at":"2026-01-24T19:17:52.000Z","dependencies_parsed_at":"2025-09-17T17:03:58.284Z","dependency_job_id":null,"html_url":"https://github.com/sudoerr/odyssey","commit_stats":null,"previous_names":["sudoerr/odyssey"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sudoerr/odyssey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoerr%2Fodyssey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoerr%2Fodyssey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoerr%2Fodyssey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoerr%2Fodyssey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sudoerr","download_url":"https://codeload.github.com/sudoerr/odyssey/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sudoerr%2Fodyssey/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32497811,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","esp32","esp32-arduino","file-sharing","webapp"],"created_at":"2025-10-06T02:10:57.767Z","updated_at":"2026-05-01T12:32:20.424Z","avatar_url":"https://github.com/sudoerr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Odyssey, ESP32 File Drive\n\nOdyssey transforms the ESP32 into a lightweight file drive server with an integrated WebApp. Using a Micro SD card, it allows you to easily store, organize, and serve files through a modern and responsive user interface.  \n\n[Watch Preview](https://github.com/sudoerr/odyssey/raw/refs/heads/main/Odyssey.mp4)\n\n## Features\n\n- [x] Complete HTTP API\n- [x] Operates as an Access Point\n- [x] File Management\n  - [x] Create folders\n  - [x] Upload, download, open, and serve files\n  - [x] Rename, move, copy, and delete files and folders*\n- [x] Modern, mobile-friendly WebApp with smooth animations\n- [x] Open files directly in the WebApp\n- [x] Correct MIME type handling and concurrent file serving\n- [x] Background processing for long tasks\n- [x] Micro SD card status reporting\n- [x] Interactive notifications and status updates in the WebApp\n- [x] Markdown Documents Support\n  - [x] Create new document\n  - [x] View Content in rich markdown format\n  - [x] Edit documents directly in the WebApp\n  - [x] Delete Documents\n\n\n\n## ToDo:\n- [ ] Add settings\n  - [ ] UI customization\n  - [ ] ESP32 network settings\n  - [ ] ESP32 username/password authentication\n  - [ ] Additional options\n- [ ] Add copy progress tracking in both UI and API\n- [ ] Clean up ESP32 Arduino code structure\n- [ ] **More Features...**\n\n\n## Hardware And Connections:\nTo run this project, you will need:\n- ESP32 board (tested with ESP32-DevkitC V4)\n- USB cable for ESP32\n- Micro SD card reader module\n- Micro SD card\n- Some wires\n- Small LED for status indication (Optional)\n- Resistor For LED (Optional)\n\n\n#### Wiring...\n\nNormally you have 6 pins on a Micro SD card module, if your module is different just adjust it to work. Also I need to mention that my ESP32 board is `ESP32-DevkitC V4` \\[[More Info](https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32/esp32-devkitc/user_guide.html)\\] So It has built-in 5V output pin and no need to do *scrap connection fixing stuff*.\n\n```text\nMODULE PIN: CS   -\u003e ESP32 PIN: 5\nMODULE PIN: SCK  -\u003e ESP32 PIN: 18\nMODULE PIN: MOSI -\u003e ESP32 PIN: 23\nMODULE PIN: MISO -\u003e ESP32 PIN: 19\nMODULE PIN: VCC  -\u003e ESP32 PIN: 5V\nMODULE PIN: GND  -\u003e ESP32 PIN: GND (any of them)\n\nLED PIN: 5V  -\u003e ESP32 PIN: 13\nLED PIN: GND -\u003e ESP32 PIN: GND (any of them)\n```\n\n\n## Usage (Software Setup)\n\n#### Upload ESP32 firrmware\n\nYou will need Arduino IDE to upload program to ESP32, and some libraries that you need to install.\n\n##### Arduino Libraries :\n\n- WIFI\n- ESPAsyncWebServer\n- SD (maybe built-in)\n- SPI (maybe built-in)\n- ArduinoJson\n- AsyncJson\n- Preferences\n\nThen open firmware folder and `OdysseyFileServer` project sketch with Arduino IDE and upload it.\n\n#### Copy WebApp Files To Micro SD Card\n\nThe `webapp` directory is the main WebApp contents that you should copy and paste in the root of Micro SD card. *(You just need to copy content inside `webapp` folder, not itself)*.\n\nNow you're ready to go, just insert micro SD card into module and power on ESP32.\n\n## Defaults\n\nThe project doesn't have settings part for now, so some of features like changing behavior of ESP32 WIFI to act as **Access Point** or **Peer** in another network.  \n\n**Therefore :**\n- Access Point SSID: `Odyssey`\n- Password: `passwordIsNotPassword`\n- Access Point IP : `10.1.1.1`\n- Access Point Port: `80` (http)\n\n*But you can change them in code anyway! for now down point is that it remains constant.*\n\n---\n\n\n### Why A File Drive On ESP32\n\nThe ESP32 is a low-power device with limited hardware resources, which makes it interesting to push its limits. This project explores what is possible and provides a useful, lightweight file server solution that can run on inexpensive hardware.\n\n\n### Contributions\nContributions, improvements, and feedback are welcome.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsudoerr%2Fodyssey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsudoerr%2Fodyssey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsudoerr%2Fodyssey/lists"}