{"id":23122702,"url":"https://github.com/folio-org/platform-complete","last_synced_at":"2025-08-17T02:31:06.988Z","repository":{"id":37237944,"uuid":"143297689","full_name":"folio-org/platform-complete","owner":"folio-org","description":"Complete set of Stripes modules for FOLIO","archived":false,"fork":false,"pushed_at":"2024-10-29T09:56:05.000Z","size":69452,"stargazers_count":13,"open_issues_count":12,"forks_count":24,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-10-29T10:03:40.270Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/folio-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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":"2018-08-02T13:21:35.000Z","updated_at":"2024-10-21T05:50:27.000Z","dependencies_parsed_at":"2023-12-18T18:20:01.348Z","dependency_job_id":"fa3af8f4-3c0e-46ff-87ff-bd58b74a8f75","html_url":"https://github.com/folio-org/platform-complete","commit_stats":null,"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fplatform-complete","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fplatform-complete/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fplatform-complete/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/folio-org%2Fplatform-complete/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/folio-org","download_url":"https://codeload.github.com/folio-org/platform-complete/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230080758,"owners_count":18169617,"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":"2024-12-17T07:29:53.279Z","updated_at":"2024-12-17T07:29:54.057Z","avatar_url":"https://github.com/folio-org.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FOLIO complete platform\n\nCopyright (C) 2015-2023 The Open Library Foundation\n\nThis software is distributed under the terms of the Apache License,\nVersion 2.0. See the file \"[LICENSE](LICENSE)\" for more information.\n\n## Introduction\n\nThis is the \"complete\" Stripes \"platform\". It consists simply of an\nNPM [`package.json`](https://docs.npmjs.com/files/package.json) that\nspecifies the version of `@folio/stripes-core` and of any Stripes\nmodules you wish to make available as part of this platform\nto generate client bundles along with a utility for generating\nmodule descriptors for each Stripes module.\n\nPlease see the\n[quick start guide](https://github.com/folio-org/stripes/blob/master/doc/quick-start.md)\nfor more information.\n\nThe `stripes.config.js` is a configuration for a specific tenant. In\ngeneral, a platform supports multiple tenants, each of which may\ninclude a different set of the available modules.  You can copy the\n`stripes.config.js` file to be your `stripes.config.js.local`\nconfiguration file.\n\nThe `yarn.lock` and `*-install.json` files in this repository can be\nused to build a FOLIO system with the components that represent the\nlatest, compatible set of FOLIO releases. For an example of how to deploy such a\nsystem, see the\n[Single Server Deployment Guide](https://juniper.docs.folio.org/docs/getting-started/installation/singleserverwithcontainers/).\n\nDescriptions of key files and key branches of this repository and\nhow to change them are in the\n[Release Procedures](https://dev.folio.org/guidelines/release-procedures/#add-to-platforms)\nand in\n[DevOps - Install Backend Module](https://dev.folio.org/guides/devops-install-backend-module/#platform-explanation).\n\n## Supported releases\n\nThe master branch is for the next flower release,\n[Morning Glory (R2-2022)](https://wiki.folio.org/pages/viewpage.action?pageId=79468624),\nit is work in progress.\n\nOnly the two latest releases are supported with critical bug and security fixes:\n* Branch [R1-2022](https://github.com/folio-org/platform-complete/tree/R1-2022) and the\n  R1-2022-… tags of the [Lotus](https://wiki.folio.org/display/REL/Lotus+%28R1+2022%29+Release+Notes)\n  release\n* Branch [R3-2021](https://github.com/folio-org/platform-complete/tree/R3-2021) and the\n  R3-2021-… tags of the [Kiwi](https://wiki.folio.org/display/REL/Kiwi+%28R3+2021%29+Release+Notes)\n  release\n\nOlder releases have reached end-of-life and are out of support.\n\n## Installation\n\nInstall platform dependencies\n```\n$ yarn config set @folio:registry https://repository.folio.org/repository/npm-folio/\n$ yarn install\n```\n\nNote: A sharp-libvips NPM dependency is not fully compatible with Nodejs v16 and will\nfail 'yarn install'.  To resolve this, set the following environment variable prior to\nrunning 'yarn install' when Nodejs version is v16+:\n\n```\nCXXFLAGS=\"-std=c++17\" \n\n```\n\n## Build and serve\n\nTo build and serve `platform-complete` in isolation for development purposes, run the \"start\" package script.\n```\n$ yarn start\n```\n\nThe default configuration assumes an Okapi instance is running on http://localhost:9130 with tenant \"diku\".  The options `--okapi` and `--tenant` can be provided to match your environment.\n```\n$ yarn start --okapi http://localhost:9130 --tenant diku\n```\n\nTo build a `platform-complete` bundle for production, modify `stripes.config.js` with your Okapi and tenant, then run the \"build\" script, passing it the name of the desired directory to place build artifacts.\n```\n$ yarn build ./output\n```\n\nSee the [build](https://github.com/folio-org/stripes-cli/blob/master/doc/commands.md#build-command) and [serve](https://github.com/folio-org/stripes-cli/blob/master/doc/commands.md#serve-command) command reference in `stripes-cli` for a list of available options.\n\n## Tests\n\n### Integration tests\n\nIntegration tests require a running Okapi.  The default configuration expects Okapi running on http://localhost:9130 with tenant \"diku\".  To build and run integration tests for `platform-complete` with these defaults, run the `test-int` script.\n```\n$ yarn test-int\n```\n\nTo view tests while they are run, provide the `--show` option.\n```\n$ yarn test-int --show\n```\n\nTo skip the build step and run integration tests against a build that is already running, provide the URL.\n```\n$ yarn test-int --url https://folio-testing.dev.folio.org/\n```\n\nAs a convenience, `--local` can be used in place of `--url http://localhost:3000` for running tests against a development server that has already been started.\n```\n$ yarn test-int --local\n```\n\n### Regression tests\n\nRegression tests for the entire platform and its apps can be run with the \"test-regression\" script.  This will invoke both cross-module tests defined in this platform's repository as well as all tests defined for the individual apps.\n\n```\n$ yarn test-regression --url https://folio-testing.dev.folio.org/\n```\n\n### Running specific tests\n\nThe `test-int` package script, when combined with the `--run` option, can be used for running specific tests for the platform and/or apps.  Use `WD` (working directory) when referencing platform tests, otherwise use the module app module name.\n\nExample running \"loan_renewal\" test in `platform-complete`:\n```\n$ yarn test-int --run WD:loan_renewal\n```\n\nExample running \"new_user\" test in `ui-users`:\n```\n$ yarn test-regression --run users:new_user\n```\n\n## Build stripes using the Dockerfile\nThe included Dockerfile allows for building a container that serves the stripes platform using Nginx. Pass in the Okapi URL and tenant ID as build arguments. The defaults are shown below:\n\n```\ndocker build -f docker/Dockerfile --no-cache=true \\\n  --build-arg OKAPI_URL=http://localhost:9130 \\\n  --build-arg TENANT_ID=diku -t stripes .\n```\nThe nginx server name can be passed to the container at runtime. The default value is `localhost` if no argument is passed. For example, to have nginx use `127.0.0.1` as the server name:\n```\ndocker run stripes 127.0.0.1\n```\n\n## Additional information\n\n[Finding what module versions are included in a flower release.](doc/finding-module-versions.md)\n\n[Finding which flower release a given installation runs.](https://lotus.docs.folio.org/docs/settings/system_software_versions/system_software_versions/)\n\nSee project [FOLIO](https://issues.folio.org/browse/FOLIO)\nat the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker/).\n\nOther FOLIO Developer documentation is at [dev.folio.org](https://dev.folio.org/)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolio-org%2Fplatform-complete","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffolio-org%2Fplatform-complete","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffolio-org%2Fplatform-complete/lists"}