{"id":16105409,"url":"https://github.com/dinbtechit/ns-ceiling-fan","last_synced_at":"2026-01-18T20:33:23.824Z","repository":{"id":107167224,"uuid":"498952886","full_name":"dinbtechit/ns-ceiling-fan","owner":"dinbtechit","description":"NS Ceiling Fan - A Monorepo links Frontend and Backend Code bases (For PROD deploy)","archived":false,"fork":false,"pushed_at":"2025-03-11T17:04:58.000Z","size":5760,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T02:44:03.741Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"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/dinbtechit.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}},"created_at":"2022-06-02T01:35:40.000Z","updated_at":"2025-03-11T17:05:02.000Z","dependencies_parsed_at":"2023-03-13T14:38:08.159Z","dependency_job_id":null,"html_url":"https://github.com/dinbtechit/ns-ceiling-fan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dinbtechit/ns-ceiling-fan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dinbtechit%2Fns-ceiling-fan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dinbtechit%2Fns-ceiling-fan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dinbtechit%2Fns-ceiling-fan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dinbtechit%2Fns-ceiling-fan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dinbtechit","download_url":"https://codeload.github.com/dinbtechit/ns-ceiling-fan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dinbtechit%2Fns-ceiling-fan/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28549844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T19:56:05.265Z","status":"ssl_error","status_checked_at":"2026-01-18T19:55:54.685Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-10-09T19:09:31.334Z","updated_at":"2026-01-18T20:33:23.805Z","avatar_url":"https://github.com/dinbtechit.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# NS Ceiling Fan\n\n## Frontend\nA front-end to interact with the fan and the display its status and settings.\n\u003e Ideally use these Government of Nova Scotia UI frameworks\nForms \u0026 Services Building Blocks\nPattern Library\n\n## Backend\nA back-end to handle the logic for operating the fan as follows:\n- The fan has two pull cords:\n- One to increase the speed each time it is pulled.\n0, 1, 2, 3 speeds\n- If pulled on speed 3, returns to 0 (“off”)\n- One to reverse direction at the current speed setting\n- Remain in same direction as speeds are cycled, until reversed again\n\n\n## High-level Architecture:\n\n\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://user-images.githubusercontent.com/17984781/171744000-6ba9ab0e-0a7c-4d51-95fa-bfb3784158df.png\"/\u003e\n\u003c/p\u003e\n\n\n# Instructions to Run\n\u003e Please note the Following instructions are for a linux distro.\n\u003e Instructions on other operating system might vary.\n\n### Prerequisites:\n\nRequires following to be installed on the machine.\n1. git (latest)\n2. docker - version 20.10.16 or higher\n3. docker-compose - version 1.29.2 or higher\n\n### Steps\n\n1. git clone ns-ceiling-fan monorepo\n```bash\ngit clone https://github.com/dinbtechit/ns-ceiling-fan.git\n```\n2. cd into the cloned repo\n```bash\ncd ns-ceiling-fan\n```\n3. git pull all submodules\n```bash\ngit submodule init\ngit pull --recurse-submodules  \u0026\u0026 git submodule update --recursive\ngit submodule update --remote --merge\n```\n4. Build Images and bring up the application.\n```bash\ndocker-compose up -d --build frontend backend\n```\n**output:**\n```\nSuccessfully built 2e19b15cdbd8\nSuccessfully tagged ns-ceiling-fan_frontend:latest\nCreating frontend ... done\nCreating redis    ... done\nCreating backend  ... done\n```\n\n5. Open browser preferably chrome (NSFan is not supported on IE)\n\n\u003e **Note:** website is accessible only on localhost.\n```\nhttp://localhost:8080\n```\n\n6. NSFan Demo\n\n\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://user-images.githubusercontent.com/17984781/171552948-8104601a-1563-4952-9ce8-852e07f2d402.gif\"/\u003e\n\u003c/p\u003e\n\n\n7. To stop all the containers \u0026 clean all the docker images\n```\ndocker-compose down -v --remove-orphans --rmi all\n```\n**output**\n```                          \nStopping frontend ... done\nStopping backend  ... done\nStopping redis    ... done\nRemoving frontend ... done\nRemoving backend  ... done\nRemoving redis    ... done\nRemoving network ns-ceiling-fan_default\nRemoving volume ns-ceiling-fan_my-redis-local\nRemoving image redis\nRemoving image ns-ceiling-fan_backend\nRemoving image ns-ceiling-fan_frontend\n```\n\n# Thank you\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdinbtechit%2Fns-ceiling-fan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdinbtechit%2Fns-ceiling-fan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdinbtechit%2Fns-ceiling-fan/lists"}