Git Product home page Git Product logo

website's Introduction

Website

Overview

This repository contains website source for kyma-project.io. The website uses GatsbyJS for static site generation and is deployed by Netlify.

NOTE: The project structure, architecture, and other project-specific details are located in the docs directory.

Prerequisites

Use the following tools to set up the project:

If your Node is in a different version than required, install NVM to switch to an older version.

Usage

Install dependencies

To install all dependencies, run this command:

npm install

Launch the website locally

Launch the development server with the hot reloading functionality that allows any change in files in the src folder to be immediately visible in the browser. Run the following command:

npm run develop

To fetch docs locally from the Kyma repository, go to the scripts/prepare-content.sh file and change APP_DOCS_OUTPUT to:

APP_DOCS_OUTPUT="{FULL_PATH_TO_REPOSITORY}/content/docs"

Then go to the root directory of the repository and run the following command:

make prepare-content-website

To debug and develop the process of fetching content, go to the tools/content-fetcher directory and run the following command:

npm start

Build the production-ready website

To build a production-ready website, run the following command:

npm run build

Run the server with the production-ready website

To serve a production-ready website, run the following command:

npm run serve

Test the website

To run unit tests, run the following command:

npm run test

Validate the website

To validate TypeScript types as well as document and code linting on the website, run the following command:

make validate

website's People

Contributors

kyma-bot avatar magicmatatjahu avatar pkosiec avatar klaudiagrz avatar derberg avatar aerfio avatar bszwarc avatar mmitoraj avatar anajankovic avatar akucharska avatar kwiatekus avatar hudymi avatar alexandra-simeonova avatar dbadura avatar pbochynski avatar grego952 avatar iwonalanger avatar nhingerl avatar a-thaler avatar tgorgol avatar m00g3n avatar pprecel avatar valentinvieriu avatar k15r avatar superojla avatar lyczeq avatar johnkbarrow avatar rjankowski93 avatar dariadomagala-sap avatar strekm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.