{"id":28791930,"url":"https://github.com/forestadmin/cloud-customizer","last_synced_at":"2025-07-15T20:33:14.557Z","repository":{"id":219136348,"uuid":"746675320","full_name":"ForestAdmin/cloud-customizer","owner":"ForestAdmin","description":"Template project to get started customizing your Forest Admin in the cloud","archived":false,"fork":false,"pushed_at":"2024-11-07T10:37:26.000Z","size":33,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-06-18T00:38:25.582Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ForestAdmin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2024-01-22T13:32:47.000Z","updated_at":"2024-11-07T10:37:29.000Z","dependencies_parsed_at":"2024-03-07T14:27:49.988Z","dependency_job_id":"7cbd96d9-5857-4a74-9edb-57f61ddf4a1a","html_url":"https://github.com/ForestAdmin/cloud-customizer","commit_stats":null,"previous_names":["forestadmin/cloud-customizer"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ForestAdmin/cloud-customizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForestAdmin%2Fcloud-customizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForestAdmin%2Fcloud-customizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForestAdmin%2Fcloud-customizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForestAdmin%2Fcloud-customizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ForestAdmin","download_url":"https://codeload.github.com/ForestAdmin/cloud-customizer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ForestAdmin%2Fcloud-customizer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265457940,"owners_count":23769031,"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":[],"created_at":"2025-06-18T00:30:49.892Z","updated_at":"2025-07-15T20:33:14.549Z","avatar_url":"https://github.com/ForestAdmin.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Usage\n\nOnce you created a new (cloud) project on forest admin,\nyou can use this package to add code customizations to it.\n\nThe workflow to add code customizations is the following:\n\n1. [Setup](#setup) the project\n2. [Write your customizations](#write-your-customizations)\n3. [Publish your customizations](#publish-your-customizations) to your project\n4. [Update typings](#update-typings) to update typings in your IDE\n5. [Refresh authentication token](#refresh-authentication-token)\n6. [Display logs](#display-logs)\n\n# Setup\n\n**Not needed if the project has already a .env file !**\n\nIf there is no `.env` file at the root of the project you need to create one with the following content:\n\n```\nFOREST_ENV_SECRET=your-env-secret\n```\n\nYou can found the `FOREST_ENV_SECRET` in the forestadmin interface, in the `Project Settings` \u003e `Environment` section\nor ask it to an administrator of the project.\n\n# Install dependencies and build\n\n`yarn install` or `npm install`\n\nthen build the project\n\n`yarn build` or `npm run build`\n\n**You can found in your `package.json` some scripts to help you to develop customizations.\nYou can replace them with your own scripts, by using directly the `forest-cloud` command.**\n\n# Write your customizations\n\nOpen the `src` folder and start writing your customizations in the `index.ts` file.\n\n**[Read the developer guide](https://docs.forestadmin.com/developer-guide-agents-nodejs/agent-customization/agent-customization)** to learn how to write customizations.\n\n# Publish your customizations\n\nYou can use `yarn` or `npm` and run `forestadmin:build:package:publish` script.\n\nThis command will build your customizations and publish them to your project.\n\nThis shortcut will run the following commands:\n\n`yarn run build` or `npm run build`\n\n```bash\nnpx forest-cloud package\nnpx forest-cloud publish\n```\n\n# Update typings\n\n**_`build` and `build:watch` scripts will update typings automatically._**\n\nBut if you want to update typings manually, you can run:\n\n`npx forest-cloud update-typings`\n\nYou can also use `yarn` or `npm` and run `forestadmin:update-typings` script.\n\nThis command will update typings according to the structure of your database and your current code customizations.\nThe typings are here to provide autocompletion in your IDE to help you write faster and avoid errors in your code.\n\nYou should execute this command on a regular basis, to keep your IDE\nupdated with your database structure and customizations.\n\n# Login\n\n`npx forest-cloud login`\n\nYou can also use `yarn` or `npm` and run `forestadmin:login` script.\n\nThis command triggers an authentication workflow and refresh the authentication token.\n\nAn alternative, is to add the `FOREST_AUTH_TOKEN` token in your `.env` file.\nYou can create one by [going to your account settings](https://app.forestadmin.com/user-settings/application-tokens/generate).\n\nThen add the following line in your `.env` file:\n```\nFOREST_AUTH_TOKEN=your-token\n```\n\n# Display logs\n\n`npx forest-cloud logs`\n\nYou can also use `yarn` or `npm` and run `forestadmin:logs` script.\n\nThis command will display the logs of your project. It's useful to debug your customizations.\nBy default, it will display the last 30 logs of the current month.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforestadmin%2Fcloud-customizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforestadmin%2Fcloud-customizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforestadmin%2Fcloud-customizer/lists"}