{"id":13553349,"url":"https://github.com/antoniosarosi/home-cloud","last_synced_at":"2025-04-05T13:09:56.419Z","repository":{"id":41592287,"uuid":"282491891","full_name":"antoniosarosi/home-cloud","owner":"antoniosarosi","description":"The \"cloud\" at home","archived":false,"fork":false,"pushed_at":"2023-01-05T23:08:09.000Z","size":3666,"stargazers_count":394,"open_issues_count":35,"forks_count":102,"subscribers_count":30,"default_branch":"master","last_synced_at":"2025-03-29T12:11:20.020Z","etag":null,"topics":["docker","docker-compose","express","javascript","nodejs","react"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/antoniosarosi.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}},"created_at":"2020-07-25T17:25:02.000Z","updated_at":"2025-02-27T09:18:52.000Z","dependencies_parsed_at":"2023-02-04T22:45:28.073Z","dependency_job_id":null,"html_url":"https://github.com/antoniosarosi/home-cloud","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniosarosi%2Fhome-cloud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniosarosi%2Fhome-cloud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniosarosi%2Fhome-cloud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antoniosarosi%2Fhome-cloud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antoniosarosi","download_url":"https://codeload.github.com/antoniosarosi/home-cloud/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247339158,"owners_count":20923014,"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","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","docker-compose","express","javascript","nodejs","react"],"created_at":"2024-08-01T12:02:22.523Z","updated_at":"2025-04-05T13:09:56.400Z","avatar_url":"https://github.com/antoniosarosi.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Home Cloud\n\n*Host your own cloud at home*\n\n#### Table of Contents\n- [Development Setup](#development-setup)\n  - [Local setup (Linux \u0026 Windows)](#local-setup-linux--windows)\n  - [Run locally](#run-locally)\n    - [Backend](#backend)\n    - [Frontend](#frontend)\n  - [Docker (Linux)](#docker-linux)\n  - [Run on Docker containers](#run-on-docker-containers)\n- [Production Setup](#production-setup)\n  - [Local (Linux \u0026 Windows)](#local-linux--windows)\n    - [Backend](#backend-1)\n    - [Frontend](#frontend-1)\n  - [Docker (Linux)](#docker-linux-1)\n\n\n## Development Setup\n\nFirst, clone the repo and cd into the project:\n```bash\ngit clone https://github.com/antoniosarosi/home-cloud.git\ncd home-cloud\n```\n\n### Local setup (Linux \u0026 Windows)\nInstall dependencies:\n```bash\ncd server\nnpm i\ncd ../client # ..\\client on Windows\nnpm i\ncd ..\n```\n\n### Run locally\n\n#### Backend\n\nMove to the server directory:\n\n```bash\ncd server\n```\n\nOpen **sample.env** and copy its content into a new file named **.env**,\nthen set the correct value for **HOME_CLOUD_STORAGE**. Now start the server:\n```bash\nnpm run dev\n```\n\n#### Frontend\n\nMove to the client directory:\n\n```bash\ncd client\n```\n\nOpen **sample.env** and copy its content into a new file named **.env**,\nthen set the correct value for **REACT_APP_API_URL**. Finally, start the \ndevelopment server:\n```bash\nnpm start\n```\n\nBackend will be running on port **5000** and frontend on port **3000** (if not\nalready in use).\n\n### Docker (Linux)\n\nFirst, set the correct value for **HOME_CLOUD_STORAGE** env variable:\n```bash\nexport HOME_CLOUD_STORAGE=\"/home/user/example\"\n```\nThen create a **.env** file in **./client/** and set this value:\n```bash\nREACT_APP_API_URL=\"http://localhost:8081\"\n```\n\nInstall dependencies:\n```bash\ndocker-compose run express npm i\ndocker-compose run react npm i\n```\n\n### Run on Docker containers\n\n```bash\ndocker-compose up\n```\n\nBackend will be running on port **8081** and frontend on port **8080** (if not\nalready in use).\n\n## Production Setup\n\n### Local (Linux \u0026 Windows)\n\n#### Backend\n\nMove to **./server/** and set the correct value for **HOME_CLOUD_STORAGE** in\n**.env** (see examples in **sample.env**), and then\nrun npm start:\n```bash\nnpm start\n```\n\n#### Frontend\nMove to **./client/** and create a file named **.env.production**, set the\ncorrect value for **REACT_APP_API_URL** (see examples in **sample.env**). Then,\ninstall serve globaly:\n```bash\nnpm i -g serve\n```\n\nBuild the app:\n\n```bash\nnpm run build # Or yarn build\n```\n\nStart the server:\n\n```bash\nserve -s build -l 3000 # Or another port of your choice\n```\n\n### Docker (Linux)\n\nFirst, set the correct value for **HOME_CLOUD_STORAGE** env variable:\n```bash\nexport HOME_CLOUD_STORAGE=\"/home/user/example\"\n```\nThen create a **.env.production** file in **./client/** and set the correct\nvalue for the API URL (your IP address and port 8081):\n```bash\nREACT_APP_API_URL=\"http://192.168.1.2:8081\"\n```\n\nBuild images and run containers:\n```bash\ndocker-compose -f docker-compose.yml -f docker-compose.prod.yml up\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoniosarosi%2Fhome-cloud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantoniosarosi%2Fhome-cloud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantoniosarosi%2Fhome-cloud/lists"}