state-less / leap Goto Github PK

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

Leap is a fullstack PWA (Progressive Web App) framework with components for the backend and frontend. It's built on react-server and Material UI. 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

(back to top)

• React.js
• Material UI
• React Server
• React Client

(back to top)

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.

This is an example of how to list things you need to use the software and how to install them.

• npm
• leap cli

1. Register for the Beta at 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)

     npm i -g @state-less/cli

3. Initialize a new backend project.

   mkdir server
   cd server
   leap init --backend
   npm install

4. Initialize a new frontend project.

   mkdir frontend
   cd frontend
   leap init --frontend
   npm install

5. Start server and frontend (open two terminals)

   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 yourself. You can clone the project.

(back to top)

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

(back to top)

• PWA
  • Authentication
    • WebAuthn
    • Google
    • Fingerprint
    • WebA3
  • Web Push
• Server Components
  • Polls
  • Comments
  • Counter (e.g. likes / stars / votes)
  • Inbox (e.g. notifications / messages)
  • [] Blog
• UI
  • Command Palette
  • Settings
• Intellisense
  • Typescript
  • [] JSDoc
• Serverless

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

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.

(back to top)

Moritz Roessler - @statelesscloud - [email protected]

Project Link: https://github.com/state-less/leap

(back to top)

• MUI

(back to top)