{"id":20263583,"url":"https://github.com/fleekhq/space-desktop","last_synced_at":"2025-04-11T02:10:34.830Z","repository":{"id":37184416,"uuid":"263150835","full_name":"FleekHQ/space-desktop","owner":"FleekHQ","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-10T21:31:22.000Z","size":3740,"stargazers_count":13,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-03-24T23:35:13.995Z","etag":null,"topics":["electron","ipfs","linux","macos","react","storage","windows"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FleekHQ.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}},"created_at":"2020-05-11T20:27:41.000Z","updated_at":"2024-05-30T11:25:05.000Z","dependencies_parsed_at":"2023-01-21T03:18:36.077Z","dependency_job_id":null,"html_url":"https://github.com/FleekHQ/space-desktop","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FleekHQ%2Fspace-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FleekHQ%2Fspace-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FleekHQ%2Fspace-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FleekHQ%2Fspace-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FleekHQ","download_url":"https://codeload.github.com/FleekHQ/space-desktop/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248328160,"owners_count":21085261,"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":["electron","ipfs","linux","macos","react","storage","windows"],"created_at":"2024-11-14T11:35:37.073Z","updated_at":"2025-04-11T02:10:34.799Z","avatar_url":"https://github.com/FleekHQ.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Test Action Status](https://github.com/FleekHQ/space-desktop/workflows/Test/badge.svg)\n![Build-Pack-Release Action Status](https://github.com/FleekHQ/space-desktop/workflows/Build-Pack-Release/badge.svg)\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `yarn electron:dev`\nRun the electron project on dev mode\n\n### `yarn clean`\nDelete build and dist folders\n\n### `yarn electron-pack [--mac, --linux, --win, --all]`\nBuild electron app to prod dist `yarn electron-pack --mac`\n\n### `yarn start`\n\nRuns the app in the development mode.\u003cbr /\u003e\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\u003cbr /\u003e\nYou will also see any lint errors in the console.\n\n### `yarn test`\n\nLaunches the test runner in the interactive watch mode.\u003cbr /\u003e\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `yarn build`\n\nBuilds the app for production to the `build` folder.\u003cbr /\u003e\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\u003cbr /\u003e\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `yarn eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can’t go back!**\n\nIf you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.\n\nYou don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.\n\n## Run dev mode + dameon process\nOn production builds the app tries to launch the daemon process from the resources builds. This behavior is disabled on dev mode, so you can run the daemon separately. If you want to run the daemon process from the app on dev mode you need to pass two env variables:\n- `DEV_DAEMON=true` to allow execute the daemon on dev mode\n- `DAEMON_PATH=/path/to/the/bin/daemon` this one points to the daemon bin on your machine\n\nAlso, if the daemon requires additional env variables, you need to pass those envs as well:\n\n`DEV_DAEMON=true DAEMON_PATH=/path/to/the/bin/daemon SOME_DAEMON_ENV=foo yarn electron:dev`\n\nYou can also download the latest version of the daemon directly into the resource folder (same way as CI does). To do that you can run `yarn download-daemon`\n\n### .env File\nTake a look at the `.env.example` file to set the necessary environment variables with its right values when you run the project locally.\n\n## Build app locally\nThe default behavior of the build process it's to try to sign the application. If you are not exporting the ENV variables required to sign the application, the build process is going to fail. If you want to skip the signing process in order to be able to run the build process locally you can pass the `CSC_IDENTITY_AUTO_DISCOVERY=false` env variable, so the sign step is going to be ignored\n\nexample:\n`CSC_IDENTITY_AUTO_DISCOVERY=false yarn electron-pack --mac`  \n\nif you want to run a build that was not signed, you need to pass an additional env variable before executing the app (to skip check for updates). Please read the next section\n\n## Run build not signed\nIf you have a build not signed, you need to disable the \"check-updates\" events, otherwise, the app is going to break. To do that you just need to launch the app from the command line passing an env variable `SKIP_AUTOUPDATE=true`\n\nso let's say that you have installed the app on your `Applications` folder (OSX), you just need to run the following command:\n\n`SKIP_AUTOUPDATE=true open /Applications/Space.app/Contents/MacOS/Space`\n\nalso you can pass additional env variables if you needed (to pass env variables required by the daemon for example)\n\n# Release\nFor the release process, will be just necessary to create and merge a PR from `develop` to `master` branch, but before creating that PR, it will be required two previous actions:\n* Create a PR to `develop`, to update the app version based on semantic versioning, and push the tag as `v\u003cAPP_VERSION\u003e`.\n**Note 1**: `v` is strictly necessary. Ex, `git tag v0.0.1`\n**Note 2**: By running `npm version \u003cpatch|minor|major\u003e`, the tag is automatically created with `v`, it just required to be pushed. Ex, `git push origin --tags  `.\n* Create a draft release selecting the tag version previously pushed.\n\nAfter doing those actions, we are ready to create the PR to make the app release. When the release PR (`develop` to `master`) is merged, the CI process will be in charge of generating the installer for each OS (mac, linux, and windows) and links to the installers will be available on the [repository releases page](https://github.com/FleekHQ/space-desktop/releases) based on the app version.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffleekhq%2Fspace-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffleekhq%2Fspace-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffleekhq%2Fspace-desktop/lists"}