UNPKG

4.14 kBMarkdownView Raw
1[![Backers on Open Collective](https://opencollective.com/react-pwa/backers/badge.svg)](https://opencollective.com/react-pwa)
2[![Sponsors on Open Collective](https://opencollective.com/react-pwa/sponsors/badge.svg)](https://opencollective.com/react-pwa)
3[![Dependencies Status](https://david-dm.org/Atyantik/pawjs.svg)](https://david-dm.org/Atyantik/pawjs)
4[![devDependencies Status](https://david-dm.org/Atyantik/pawjs/dev-status.svg)](https://david-dm.org/Atyantik/pawjs?type=dev)
5[![Known Vulnerabilities](https://snyk.io/test/github/Atyantik/pawjs/badge.svg)](https://snyk.io/test/github/Atyantik/pawjs)
6
7[![Join the chat at https://gitter.im/react-pwa](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/react-pwa/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
8
9
10<p align="center" style="text-align:center">
11 <img src="https://www.atyantik.com/wp-content/uploads/2018/06/192-192.png" alt="Paw JS"/>
12</p>
13<h1 align="center" style="text-align:center">Paw JS - The plugable framework</h1>
14
15
16A highly scalable & plugable, **Progressive Web Application *Framework*** with the best Developer Experience.
17This framework utilizes the power of React with Webpack and is build on top of webpack/tapable for unlimited extendability.
18
19
20
21#### No configuration required
22You start the development with nothing but just one single file i.e. `src/routes.js`
23
24### Getting Started
25To install and get started with PawJS execute the following commands:
26
27##### 1. Clone the repo to your local PC and go to the installation
28```bash
29git clone https://github.com/Atyantik/pawjs.git && cd pawjs
30```
31
32##### 2. Install the dependencies
33```bash
34npm install
35```
36
37
38##### 3. Prepare the packages and demo project
39```bash
40npm run prepare-demo
41```
42
43##### 4. Start the demo project
44```bash
45npm run start
46```
47
48#### Features
49##### PWA - Progressive Web Applications
50Create Progressive web application with ReactJS. As we all know, Progressive Apps are not supported everywhere, but we have added support for Safari & Chrome so your application can work as
51standalone applications when added to home-screen or saved as desktop app.
52
53##### Code splitting
54The very difficulty faced when developing enterprise application is code splitting. We don't need everything in a single JS file. Why not simply split the code with `import()` and create bundles!
55We make it really easy here to just create a page that returns an array of routes. Code is split and loaded automatically when the respective route is called.
56
57##### ES6/7 Compatible
58Using babel, we support next generation JavaScript syntax including Object/Array destructuring, arrow functions, JSX syntax and more...
59
60##### Universal Routing with React-Router
61We are using the most accepted React router for routing the application. Add your favorite /about, /contact, /dashboard pages.
62
63##### Offline support with Google Workbox
64Yes your application is offline available. Run without internet. Pretty cool huh?? Well all thanks to service workers and google workbox
65for handling the cache & network strategies.
66
67##### SSR - Server side rendering
68The best way to get your application SEO-ed is enable Server side rendering i.e. Universal applications
69You can have SSR running during development as well.
70
71##### SEO
72Our customized routes enable creating meta tags to create Twitter, Google+, Linkedin, Facebook cards. We know how important SEO is to an application.
73
74##### HSTS Supported
75Enable HSTS for secure sites. Options to define maxAge and preload of HSTS. All with very simple configuration.
76
77### Supporters
78##### Atyantik Technologies Private Limited
79Everyone at Atyantik Technologies is contributing their free time for contributing to the project and core discussions.
80<a href="https://www.atyantik.com" target="_blank"><img width="150px" src="https://www.reactpwa.com/img/supporters/atyantik.svg"></a>
81
82
83### License
84This project is licensed under the MIT license, Copyright (c) 2018 [Atyantik Technologies Private Limited](https://www.atyantik.com). For more information see [LICENSE.md]("https://github.com/Atyantik/pawjs/blob/master/LICENSE.md").
\No newline at end of file