https://github.com/tobitsoftware/chayns-react-template

This is an template to use chayns® + React
https://github.com/tobitsoftware/chayns-react-template

Last synced: 27 days ago
JSON representation

This is an template to use chayns® + React

• Host: GitHub
• URL: https://github.com/tobitsoftware/chayns-react-template
• Owner: TobitSoftware
• License: mit
• Created: 2019-11-25T08:49:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-10-27T15:05:09.000Z (over 5 years ago)
• Last Synced: 2025-12-01T18:55:08.598Z (7 months ago)
• Language: JavaScript
• Size: 760 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
> **DEPRECATION NOTICE**

>

> This Project has been replaced with our new CLI tool for spinning up projects,

> [`create-chayns-app`](https://github.com/TobitSoftware/create-chayns-app), and

> will not receive updates going forward.

>

> For a more in-depth guide to start developing content for chayns, visit the

> [`create-chayns-app`](https://github.com/TobitSoftware/create-chayns-app)

> repository.



    
chayns-react-template

    
A starter template for developing chayns® Pages with React.



---

## Overview

-   [Quick Start](#quick-start)

-   [Detailed Guide](#detailed-guide)

    -   [System Requirements](#system-requirements)

    -   [Get Up and Running](#get-up-and-running)

## Quick Start

1. `npm install`

2. `npm run dev` to start a dev server on `http://localhost:1234/`

3. `npm run build` to create a production bundle

You should also replace the values with your own:

-   `name`-field in `package.json`

-   Content of `` in `src/index.html`

## Detailed Guide

### System Requirements

-   **Git**

    You must have Git installed on your system. If you do not already have it,

    get it [here](https://git-scm.com/downloads). You do not need to know much

    about git to start with this template.

-   **Node.js** >=12.10

    You must also have Node.js version 12.10 or greater installed. If you do not

    already have it, get it [here](https://nodejs.org/).

### Get Up and Running

#### 1. Open a terminal in the directory you want to develop in

On windows this can be done with `Shift + Right-Click` in the explorer and

`Open PowerShell here`. On macOS, right-click the parent folder and choose

`Open Terminal here`.

#### 2. Clone the repository

You should have Git installed by now, so in the newly opened window just run

`git clone https://github.com/TobitSoftware/chayns-react-template.git my-project`.

You can replace `my-project` in the command with the name of your project.

After a short process the project files can be found in the `my-project` folder

(or whatever you named it).

#### 3. Open the project in a code editor

If you do not already have a code editor,

[Visual Studio Code](https://code.visualstudio.com/) is a good one.

You can open a folder in Visual Studio Code via `File > Open Folder...` in the

top menu.

#### 4. Install `npm` packages

Run `npm install` in the project directory. In Visual Studio Code, you can get a

terminal in the current folder via `Terminal > New Terminal` in the top menu.

#### 5. Run `npm run dev`

To start developing your custom page, run the `npm run dev` command. Add a page

with the URL `http://localhost:1234/` to your chayns-Site. You will see your

page running there.

> Be aware that this is only a local version of your page, so no other devices

> can access your development server.