beyond/README.md

The Full Stack Universal Typescript Framework

<div align="center">

![BeyondJS The universal meta-framework](https://beyondjs.com/images/beyond-logo.png)

<h3>The meta-framework for universal packages</h3>
</div>
<dl>
  <dt>&nbsp;</dt>
</dl>
<p>
  <a aria-label="License MIT" href="https://opensource.org/licenses/MIT">
    <img  src="https://img.shields.io/static/v1?style=for-the-badge&label=License&message=MIT&color=red">
  </a>
  <a aria-label="NPM version" href="https://www.npmjs.com/package/beyond">
    <img alt="" src="https://img.shields.io/static/v1?style=for-the-badge&label=Version&message=1.2.5&color=#dcdcdc">
  </a>
  
  <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
  [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=for-the-badge)](#contributors)
  <!-- ALL-CONTRIBUTORS-BADGE:END -->

</p>
<dl>
  <dt>&nbsp;</dt>
</dl>

# Getting started

## Global instalation

```shell
npm i -g beyond
```

## Install and create beyondJS package

```shell
npx @beyond-js/create-package
```

The final command is interactive, allowing you to select the type of project you wish to create from the following
options:

    -   web: Ready to start a web project that can be distributed on the internet or as a mobile application.
        Here you can select between use
        - React
        - Svelte
        - Node
        - Integrate another render engine library.
    -   node: Ready to distribute as a project to run in a node environment.
    -   backend: Node project that makes available interfaces that could be consumed in real-time with web socket from another node project or a client project.
    -   library: Ideal for creating projects intended to be distributed as NPM packages.
    -   web-backend: Generates a web project with a backend distribution.

-   **--container**: you can use it if you want to create your project in a new folder

For more information go to [@beyond-js/create-package](https://www.npmjs.com/package/@beyond-js/create-package)

You can also go to our documentation site to see the [quick start](https://beyondjs.com/docs/quick-start).

# Colaborate with us

We are looking for developers who want to help us test the project in all environments. If you work in a javascript
environment, and you like the idea of using universal javascript like we do, feel free to download it, try it and
contact us.

# Semver

BeyondJS is following [Semantic Versioning 2.0](https://semver.org/).

[//]: # '# Contributors'
[//]: #
[//]: # '<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->'
[//]: # '<!-- prettier-ignore-start -->'
[//]: # '<!-- markdownlint-disable -->'
[//]: #
[//]: # '<!-- markdownlint-restore -->'
[//]: # '<!-- prettier-ignore-end -->'
[//]: #
[//]: # '<!-- ALL-CONTRIBUTORS-LIST:END -->'