{"id":20064007,"url":"https://github.com/eswat2/proto-notes-dkr","last_synced_at":"2026-05-19T10:35:02.671Z","repository":{"id":60872322,"uuid":"539603560","full_name":"eswat2/proto-notes-dkr","owner":"eswat2","description":"a simple UI and API server packaged with Docker...","archived":false,"fork":false,"pushed_at":"2025-07-24T14:33:25.000Z","size":839,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-24T19:25:57.384Z","etag":null,"topics":["docker","vue","websocket"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eswat2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-09-21T17:18:10.000Z","updated_at":"2025-07-24T14:33:29.000Z","dependencies_parsed_at":"2023-11-16T16:44:03.380Z","dependency_job_id":"e728f2cb-29e2-4990-a30f-1c1908dcc80a","html_url":"https://github.com/eswat2/proto-notes-dkr","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eswat2/proto-notes-dkr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eswat2%2Fproto-notes-dkr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eswat2%2Fproto-notes-dkr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eswat2%2Fproto-notes-dkr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eswat2%2Fproto-notes-dkr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eswat2","download_url":"https://codeload.github.com/eswat2/proto-notes-dkr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eswat2%2Fproto-notes-dkr/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267093916,"owners_count":24034957,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"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":["docker","vue","websocket"],"created_at":"2024-11-13T13:44:30.831Z","updated_at":"2026-05-19T10:35:02.621Z","avatar_url":"https://github.com/eswat2.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# proto-notes-dkr\n\nThis project was orgininally setup as independent pieces.  There were 2 parts:\n\n- a UI written in Vue, deployed to Vercel\n- an API server written in Node, deployed to Heroku\n\nThe original idea came from an Egghead course i took.  That course built a UI in React with a backend in Firebase.  I wrote my own server to replace Firebase, built with Node and Websockets, just to explore how this all worked.  The server part was called **fire-notes** and that part is in the api folder of this repo.  I later rewrote the UI while exploring Vue and that was called **git-notes**.  That UI now lives in the app folder of this repo.  To simplify things, the Websocket and server connections aren't encrypted, not a big deal since they only run inside this container and it's not designed to be deployed anywhere.\n\nSince the Free tier of Heroku is going away in November of 2022, i decided to repackage this project as a Docker container.  When it's running locally, it exposes the following:\n\n- [localhost:3000][xoc-app] - _the Vue app_\n- [localhost:8082][xoc-wss] - _websocket server_\n- [localhost:8182][xoc-api] - _api server (REST)_\n\n## docker\n\nTo run this multi-part app:\n\n1. `docker-compose build`\n2. `docker-compose up`\n\n```\n➜  proto-notes-dkr git:(main) ✗ docker-compose up\n[+] Running 3/2\n ⠿ Network proto-notes-dkr_backbone  Created                               0.0s\n ⠿ Container proto-notes-dkr-api-1   Created                               0.0s\n ⠿ Container proto-notes-dkr-app-1   Created                               0.0s\nAttaching to proto-notes-dkr-api-1, proto-notes-dkr-app-1\nproto-notes-dkr-api-1  | yarn run v1.22.19\nproto-notes-dkr-api-1  | $ yarn; node app.mjs\nproto-notes-dkr-api-1  | [1/4] Resolving packages...\nproto-notes-dkr-app-1  | yarn run v1.22.19\nproto-notes-dkr-app-1  | $ yarn; vite build; vite preview --host 0.0.0.0\nproto-notes-dkr-api-1  | success Already up-to-date.\nproto-notes-dkr-api-1  | -- Notes Server listening on port 8182\nproto-notes-dkr-api-1  | -- Websocket Server created on port 8082\nproto-notes-dkr-api-1  | -- http://localhost:8182\nproto-notes-dkr-app-1  | [1/4] Resolving packages...\nproto-notes-dkr-app-1  | [2/4] Fetching packages...\nproto-notes-dkr-app-1  | [3/4] Linking dependencies...\nproto-notes-dkr-app-1  | [4/4] Building fresh packages...\nproto-notes-dkr-app-1  | vite v3.1.3 building for production...\nproto-notes-dkr-app-1  | transforming...\nproto-notes-dkr-app-1  | ✓ 101 modules transformed.\nproto-notes-dkr-app-1  | rendering chunks...\nproto-notes-dkr-app-1  | dist/assets/favicon.db74ab0b.ico   4.19 KiB\nproto-notes-dkr-app-1  | dist/index.html                    1.37 KiB\nproto-notes-dkr-app-1  | dist/assets/index.4a29606e.css     1.24 KiB / gzip: 0.52 KiB\nproto-notes-dkr-app-1  | dist/assets/index.3fed08c7.js      92.85 KiB / gzip: 35.48 KiB\nproto-notes-dkr-app-1  |   ➜  Local:   http://localhost:3000/\nproto-notes-dkr-app-1  |   ➜  Network: http://172.18.0.3:3000/\n```\n\nIf you prefer, there are yarn commands to handle all of this:\n\n- `yarn build` - _docker-compose build_\n- `yarn start` - _docker-compose up_\n- `yarn stop` - _docker-compose down_\n\nThese scripts are just a shortcuts to running `docker-compose`.\n\nYou will notice that we're not installing any npm packages locally in order to build and run this app suite.  All of that is handled by Docker...\n\n## requirements\n\n- [Docker Desktop for OSX][docker-osx]\n- [Docker Desktop for Windows][docker-win]\n\n## who\n\n- Richard Hess\n- [https://eswat2.github.io][eswat2-io]\n\n\n[eswat2-io]: https://eswat2.github.io\n[xoc-app]: http://localhost:3000\n[xoc-wss]: http://localhost:8082\n[xoc-api]: http://localhost:8182\n\n[docker-osx]: https://docs.docker.com/docker-for-mac/\n[docker-win]: https://docs.docker.com/docker-for-windows/","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feswat2%2Fproto-notes-dkr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feswat2%2Fproto-notes-dkr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feswat2%2Fproto-notes-dkr/lists"}