Snek Jaen Template

This is the official jaen projects of snek-at. Free, sexy and cutting edge CMS framework for ReactJS.

"A bowl is most useful when it is empty." - Lao Tzu

Report bug · Request feature · Documentation

Table of contents

• Table of contents
• Motivation
• Quick start
  • Codespace setup
  • Local setup
• Bugs and feature requests
• Contributing
• Versioning
• Creators
• Thanks
• Copyright and license

Motivation

A CMS should not be the defining feature of a webapp. Nighter should Ecommerce or anything other than your code.
ERP integration should not force developer to cut corners.

• Jaen does not interfere with your user experience.
• Jean does not challange your application design.
• Jaen gives the power back to you.

One thing and one thing only with clean and well documented interfaces. Customizable, extensible and open-source.

Msg inspiring ppl:
Chasing ones own tail is not inspiring.

Disclaimer:
Not for crybabies. Do not touch if you are affraid to be a bit scratche.

Quick start

Several quick start options are available:

• Generate repository from template: Generate Jaen on GitHub

Codespace setup

The easiest method is to use a GitHub Codespace (in beta). Just create a GitHub Codespace from the Code menu. Wait for the Codespace to complete provisioning. When the Codespace has completed provisioning open a terminal window (Ctrl-`, Control-backquote) and:

• Start a local copy of the docs site with npm start
• Or build a local copy of the library with npm run build

Local setup

If you set this up locally, make sure you have the following pre-requisites:

• Add github npm registry: npm login --registry=https://npm.pkg.github.com
• Use npm install to install all dependencies
• Start a local copy of the docs site with npm start
• Or build a local copy of the library with npm run build

The demo site will now be accessible at http://localhost:3000/.

Bugs and feature requests

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

All code should conform to the Code Guide, maintained by snek-at.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this repository is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

Creators

Nico Schett	Florian Kleber

Thanks

We do not have any external contributors yet, but if you want your name to be here, feel free to contribute to our project.

Copyright and license

SPDX-License-Identifier: EUPL-1.2 SPDX-FileCopyrightText: Copyright © 2021 snek.at