Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 2.91 KB

README.md

File metadata and controls

60 lines (43 loc) · 2.91 KB
Raw

SCM-Manager

scm-manager.org

This repository contains sources of the scm-manager main website scm-manager.org. The website is build with GatsbyJS.

Development

To build the website in development mode, we need the following content from the core and plugin repositories:

  • README.md
  • CHANGELOG.md
  • LICENSE.txt
  • and the docs folder

The content can be fetched automatically by using the collect-content script from the package.json.

The script requires a valid GitHub API token with full access to repositories. That means that you have to tick off the repo scope (Full control of private repositories). For help how to create a token have a look at the GitHub topic:
Creating a personal access token.

After the access token is copied, we have to export the token as environment variable GITHUB_API_TOKEN. Now we are able to run the collect-content script and than we can start gatsby in development mode.

export GITHUB_API_TOKEN="your_github_api_token"
yarn install
yarn run collect-content
yarn run develop

Search Index

To build and test the search, first create a .env file in this projects root directory, it should never be checked into git.

It should contain the following properties:

GATSBY_ALGOLIA_APP_ID=?
GATSBY_ALGOLIA_SEARCH_KEY=?
ALGOLIA_ADMIN_KEY=?

Replace the question marks with API Keys from the Algolia web app. Do not use the production application (SCM-Manager Website) or use GATSBY_ALGOLIA_INDEX to set a custom test index!

Afterwards you have to run the build script once, so that the index is published to Algolia.

The search is now ready and available to your development environment.

Need help?

Looking for more guidance? Full documentation lives on our homepage or the dedicated pages for our plugins. Do you have further ideas or need support?

  • Community Support - Contact the SCM-Manager support team for questions about SCM-Manager, to report bugs or to request features through the official channels. Find more about this here.

  • Enterprise Support - Do you require support with the integration of SCM-Manager into your processes, with the customization of the tool or simply a service level agreement (SLA)? Contact our development partner Cloudogu! Their team is looking forward to discussing your individual requirements with you and will be more than happy to give you a quote. Request Enterprise Support.