https://github.com/state-less/leap
The leap fullstack framework
https://github.com/state-less/leap
Last synced: 2 months ago
JSON representation
The leap fullstack framework
- Host: GitHub
- URL: https://github.com/state-less/leap
- Owner: state-less
- Created: 2022-02-24T09:58:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-07T20:52:21.000Z (almost 4 years ago)
- Last Synced: 2026-01-02T23:14:28.785Z (6 months ago)
- Language: TypeScript
- Size: 1.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Leap
Leap is a modern fullstack PWA framework.
Build the web of tomorrow with server side react components.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Leap is a fullstack PWA (Progressive Web App) framework with components for the backend and frontend.
It's built on [react-server][react-server] and [Material UI](http://mui.com).
Build blazing fast web applications in minutes by using react components as building blocks for your backend.
Digitalize your buisiness process and build a growing ecosystem of scalable microservices.
Check out the demo here [state-less.cloud](https://state-less.cloud)
### Built With
- [React.js](https://reactjs.org/)
- [Material UI](https://mui.com)
- [React Server](https://state-less.cloud/react-server)
- [React Client](https://state-less.cloud/react-client)
## Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- npm
- leap cli
### Installation
1. Register for the Beta at [https://state-less.cloud](https://state-less.cloud)
2. Install the cli (we will change to a npx based solution later. But for now that's the easieast way)
```sh
npm i -g @state-less/cli
```
3. Initialize a new backend project.
```sh
mkdir server
cd server
leap init --backend
npm install
```
4. Initialize a new frontend project.
```sh
mkdir frontend
cd frontend
leap init --frontend
npm install
```
5. Start server and frontend (open two terminals)
```js
cd server
npm start
cd frontend
npm start
```
The backend should be running at port 8080 and the frontend on port 3000. If you want to run the [demo page](https://state-less.cloud) yourself. You can clone the [project](https://github.com/state-less/leap-demo).
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
## Roadmap
- PWA
- [x] Authentication
- [x] WebAuthn
- [x] Google
- [x] Fingerprint
- [x] WebA3
- [x] Web Push
- Server Components
- [x] Polls
- [x] Comments
- [x] Counter (e.g. likes / stars / votes)
- [x] Inbox (e.g. notifications / messages)
- [] Blog
- UI
- [x] Command Palette
- [x] Settings
- Intellisense
- [x] Typescript
- [] JSDoc
- [x] Serverless
See the [open issues](https://github.com/state-less/leap/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project doesn't have a license yet; which is subject to change.
Until a proper alpha release it's distribution and distribution of derivates is prohibited.
There is currently no 'LICENSE.txt'. Once their will be a LICENSE.txt it will be in effect immediately.
The license is open for change at any time. Users who obtained a copy before the change are subject to those changes as well.
The license will most probably become MIT once this project reaches production.
## Contact
Moritz Roessler - [@statelesscloud](https://twitter.com/statelesscloud) - admin@state-less.cloud.com
Project Link: [https://github.com/state-less/leap](https://github.com/state-less/leap)
## Acknowledgments
- [MUI](https://mui.com)
[contributors-shield]: https://img.shields.io/github/contributors/state-less/leap.svg?style=for-the-badge
[contributors-url]: https://github.com/state-less/leap/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/state-less/leap.svg?style=for-the-badge
[forks-url]: https://github.com/state-less/leap/network/members
[stars-shield]: https://img.shields.io/github/stars/state-less/leap.svg?style=for-the-badge
[stars-url]: https://github.com/state-less/leap/stargazers
[issues-shield]: https://img.shields.io/github/issues/state-less/leap.svg?style=for-the-badge
[issues-url]: https://github.com/state-less/leap/issues
[license-shield]: https://img.shields.io/github/license/state-less/leap.svg?style=for-the-badge
[license-url]: https://github.com/state-less/leap/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/moritz-roessler-666b18175
[product-screenshot]: /images/screenshot.jpg?raw=true
[react-server]: https://github.com/state-less/react-server