-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add readme and include all previouse commits that do not follo…
…w commitizen Almost all previous commits do not follow the Angular Conventional Commits convention. Therefore v1.0.0 cannot be created. This commits will be marked as breaking in order to trigger a release. BREAKING CHANGE: Added first version of jaen.
- Loading branch information
Showing
1 changed file
with
120 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,140 @@ | ||
| # Getting Started with Create React App | ||
| <p align="center"> | ||
| <a href="https://snek.at/" target="_blank" rel="noopener noreferrer"> | ||
| <img src="https://avatars2.githubusercontent.com/u/55870326?s=400&u=c6c7f06305ddc94747d474850fde7b2044f53838&v=4" alt="SNEK Logo" height="150"> | ||
| </a> | ||
| </p> | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| <h3 align="center">snek-at - Jaen aka snek(J)</h3> | ||
|
|
||
| ## Available Scripts | ||
| <p align="center"> | ||
| This is the official jaen-cms projects of snek-shipyard. | ||
| Free, sexy and cutting edge CMS framework for ReactJS. | ||
| <br> | ||
| <br> | ||
| <cite>"A bowl is most useful when it is empty."</cite> - Lao Tzu | ||
| <br> | ||
| <br> | ||
| <a href="https://github.com/snek-shipyard/jaen-cms/issues/new?template=bug_report.md">Report bug</a> | ||
| · | ||
| <a href="https://github.com/snek-shipyard/jaen-cms/issues/new?template=feature_request.md">Request feature</a> | ||
| · | ||
| <a href="https://www.overleaf.com/read/bcxwhwbhrmps">Documentation</a> | ||
| <br> | ||
| <br> | ||
| <a href="https://www.codacy.com/gh/snek-shipyard/jaen-cms/dashboard?utm_source=github.com&utm_medium=referral&utm_content=snek-shipyard/jaen-cms&utm_campaign=Badge_Grade"> | ||
| <img src="https://app.codacy.com/project/badge/Grade/bb3d984d38704860ba7ad800d319b8c4" /> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Table of contents | ||
|
|
||
| - [Table of contents](#table-of-contents) | ||
| - [Motivation](#motivation) | ||
| - [Quick start](#quick-start) | ||
| - [Codespace setup](#codespace-setup) | ||
| - [Local setup](#local-setup) | ||
| - [Bugs and feature requests](#bugs-and-feature-requests) | ||
| - [Contributing](#contributing) | ||
| - [Versioning](#versioning) | ||
| - [Creators](#creators) | ||
| - [Thanks](#thanks) | ||
| - [Copyright and license](#copyright-and-license) | ||
|
|
||
| In the project directory, you can run: | ||
| ## [](#motivation)Motivation | ||
|
|
||
| ### `npm start` | ||
| A CMS **shouldn not** be the defining feature of a webapp. Nighter should Ecommerce or anything other than your code. \ | ||
| ERP integration **shouldn not** force developer to cut corners. | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in the browser. | ||
| - Jaen **does not** interfere with **your** user experience. | ||
| - Jean **does not** challange **your** application design. | ||
| - Jaen gives the power back to **you**. | ||
|
|
||
| The page will reload if you make edits.\ | ||
| You will also see any lint errors in the console. | ||
| One thing and one thing only with clean and well documented interfaces. | ||
| Customizable, extensible and open-source. | ||
|
|
||
| ### `npm test` | ||
| **Msg inspiring ppl:** \ | ||
| Chasing ones own tail is not inspiring. | ||
|
|
||
| Launches the test runner in the interactive watch mode.\ | ||
| See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. | ||
| **Disclaimer:** \ | ||
| Not for crybabies. Do not touch if you are affraid to be a bit scratche. | ||
|
|
||
| ### `npm run build` | ||
| ## [](#quick-start)Quick start | ||
|
|
||
| Builds the app for production to the `build` folder.\ | ||
| It correctly bundles React in production mode and optimizes the build for the best performance. | ||
| Several quick start options are available: | ||
|
|
||
| The build is minified and the filenames include the hashes.\ | ||
| Your app is ready to be deployed! | ||
| - Generate repository from template: [Generate Jaen on github](https://github.com/snek-shipyard/jaen-template/generate) | ||
|
|
||
| See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. | ||
| ### Codespace setup | ||
|
|
||
| ### `npm run eject` | ||
| The easiest method is to use a GitHub [Codespace](https://github.com/features/codespaces) (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: | ||
|
|
||
| **Note: this is a one-way operation. Once you `eject`, you can’t go back!** | ||
| - Start a local copy of the docs site with `npm start` | ||
| - Or build a local copy of the library with `npm run build` | ||
|
|
||
| If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. | ||
| ### Local setup | ||
|
|
||
| Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. | ||
| If you set this up locally, make sure you have the following pre-requisites: | ||
|
|
||
| You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. | ||
| - 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` | ||
|
|
||
| ## Learn More | ||
| The demo site will now be accessible at <http://localhost:3000/>. | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| ## [](#bug-and-feature-requests)Bugs and feature requests | ||
|
|
||
| To learn React, check out the [React documentation](https://reactjs.org/). | ||
| 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](https://github.com/snek-shipyard/jaen-cms/issues/new/choose). | ||
|
|
||
| ## [](#contributing)Contributing | ||
|
|
||
|  | ||
|  | ||
|  | ||
|
|
||
| Please read through our | ||
| [contributing guidelines](https://github.com/snek-shipyard/jaen-cms/blob/master/CONTRIBUTING.md). Included are | ||
| directions for opening issues, coding standards, and notes on development. | ||
|
|
||
| All code should conform to the [Code Guide](https://github.com/snek-shipyard/tonic/blob/master/STYLE_GUIDE.md), maintained by | ||
| [snek-shipyard](https://github.com/snek-shipyard). | ||
|
|
||
| ## [](#versioning)Versioning | ||
|
|
||
| For transparency into our release cycle and in striving to maintain backward compatibility, this repository is | ||
| maintained under [the Semantic Versioning guidelines](https://semver.org/). Sometimes we screw up, but we adhere to | ||
| those rules whenever possible. | ||
|
|
||
| ## [](#creators)Creators | ||
|
|
||
| <table border="0"> | ||
| <tr> | ||
| <td> | ||
| <a href="https://github.com/schettn"> | ||
| <img src="https://avatars.githubusercontent.com/schettn?s=100" alt="Avatar schettn"> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <a href="https://github.com/kleberbaum"> | ||
| <img src="https://avatars.githubusercontent.com/kleberbaum?s=100" alt="Avatar kleberbaum"> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><a href="https://github.com/schettn">Nico Schett</a></td> | ||
| <td><a href="https://github.com/kleberbaum">Florian Kleber</a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## [](#thanks)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](#contributing). | ||
|
|
||
| ## [](#copyright-and-license)Copyright and license | ||
|
|
||
|  | ||
|
|
||
| SPDX-License-Identifier: EUPL-1.2 | ||
| SPDX-FileCopyrightText: Copyright © 2021 snek.at |