From 2ea1e7b522f09883a716be71925ffa9cc4daec46 Mon Sep 17 00:00:00 2001 From: Brandon Bayer Date: Mon, 20 Apr 2020 21:27:02 +0700 Subject: [PATCH] restore buried readme updates --- README | 1 + README.md | 150 --------------------------------------- packages/blitz/README.md | 49 +++++++++---- 3 files changed, 36 insertions(+), 164 deletions(-) create mode 120000 README delete mode 100644 README.md diff --git a/README b/README new file mode 120000 index 000000000..38ea2298f --- /dev/null +++ b/README @@ -0,0 +1 @@ +packages/blitz/README.md \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 3010f598a..000000000 --- a/README.md +++ /dev/null @@ -1,150 +0,0 @@ -[![Blitz.js](https://raw.githubusercontent.com/blitz-js/art/master/github-cover-photo.png)](https://blitzjs.com) - - -

- - - - - - - - - - - - -

- - -
- -

Blitz is a Rails-like framework for monolithic, full-stack React apps

- -
- -Blitz brings back the **simplicity and conventions** of server rendered frameworks like Ruby on Rails while preserving everything we love about React and client-side rendering! - -Blitz is the framework for the 99% of us at companies with <100 employees. This means **we don't force you to use advanced technologies like GraphQL**. We let you add advanced technologies on your terms and at your pace. - -Blitz **maximizes your productivity** both when starting an app and when scaling it to lots of code and users. - -
- -**Features:**
-⚡️ Built on Next.js
-⚡️ Don't have to build an API for client-side rendering
-⚡️ Client-side rendering, Server-side rendering, and fully static pages all in the same app
-⚡️ Full Typescript support with static, end-to-end typing (no code generation step needed like with GraphQL)
-⚡️ React Concurrent Mode enabled
-⚡️ Database/ORM agnostic, but Prisma 2 is default
-⚡️ CLI with code scaffolding, Rails-style console REPL, etc
-⚡️ GraphQL Ready
-⚡️ Deploy serverless or serverful
- -**Other key features coming:**
-⚡️ Highly secure authentication
-⚡️ Authorization you can use on both server and client
-⚡️ Model validation you can use on both server and client
-⚡️ Plugins for easily adding libaries like Tailwind, CSS-in-JS, etc.
-⚡️ React native support
-⚡️ GUI so you don't have to use the CLI
- -
- -### Initial Alpha Release Coming Soon - -We expect an initial alpha release to be ready the week of April 20, 2020. In the meantime, [check out the Architecture RFC](https://github.com/blitz-js/blitz/pull/73) and view the example app here: [`examples/store`](https://github.com/blitz-js/blitz/tree/canary/examples/store) - -
- -### What is Blitz Designed For? - -Blitz is designed for tiny to large database-backed applications that have one or more graphical user interfaces. - -While we currently only support web, we are pursuing the dream of a single monolithic application that runs on web and mobile with maximum code sharing and minimal boilerplate. - -
- -### What are the Foundational Principles? - -1. Fullstack & Monolithic -2. API Not Required -3. Convention over Configuration -4. Loose Opinions -5. Easy to Start, Easy to Scale -6. Stability -7. Community over Code - -[The Blitz Manifesto](https://github.com/blitz-js/blitz/blob/canary/MANIFESTO.md) explains these principles in detail. - -
- -## Welcome to the Blitz Community 👋 - -The Blitz community is warm, safe, diverse, inclusive, and fun! LGBTQ+, women, and minorities are especially welcome. Please read our [Code of Conduct](https://github.com/blitz-js/blitz/blob/canary/CODE_OF_CONDUCT.md). - -[Join our Slack Community](https://slack.blitzjs.com) where we help each other build Blitz apps. It's also where collaborate on building Blitz itself. - -There's still a lot of work to do, so you are especially invited to join us in building Blitz! A good place to start is the [The Contributing Guide](CONTRIBUTING.md). - -
- -## Sponsors and Donations - -- Contribute via [GitHub Sponsors](https://github.com/sponsors/blitz-js) -- Contribute via [PayPal](https://paypal.me/thebayers) -- Contribute via [Open Collective](https://opencollective.com/blitzjs) -- Contribute via [Patreon](https://patreon.com/flybayer) - -_Sponsor Blitz and display your logo and hiring status here. This is a great way to get in front of early adopters! [See options on Open Collective](https://opencollective.com/blitzjs)_ - -
- -## Contributors ✨ - -Thanks to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Brandon Bayer
💻 🖋 🤔 👀
Michael Edelman
🚇 💻
Dylan Brookes
🤔 👀 💻
Rudi Yardley
💻 🤔
Todd Geist
💵
Beata Obrok
💻
Tahir Awan
💻

Camilo Gonzalez
💻
Daniel Kempner
💻
Giel
💻
Jeremy Liberman
💻
Jim Cummins
💻
Kristina Matuška
🎨
Robert Rosenberg
💻

Jason Blalock
💻
Corey Brown
💻
aej11a
💻
marcoseoane
🤔
Rishabh Poddar
🤔
Adam Markon
🤔
Lorenzo Rapetti
💻

Justin Hall
💻
Sajjad Hashemian
💻
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/packages/blitz/README.md b/packages/blitz/README.md index eee258be1..3010f598a 100644 --- a/packages/blitz/README.md +++ b/packages/blitz/README.md @@ -19,13 +19,42 @@
-### Blitz is a Rails-like framework for monolithic, full-stack React apps. +

Blitz is a Rails-like framework for monolithic, full-stack React apps


-The central thesis is that most apps don’t need a REST or GraphQL API. Blitz brings back the simplicity of server rendered frameworks like Ruby on Rails while preserving everything we love about React and client-side rendering. +Blitz brings back the **simplicity and conventions** of server rendered frameworks like Ruby on Rails while preserving everything we love about React and client-side rendering! -Additionally, Blitz is bringing other Rails goodness that’s missing in the React ecosystem like file structure and routing conventions, a really nice console REPL, intelligent code-scaffolding, and a fine-tuned out-of-the-box setup with Prettier, Typescript, ESlint, Jest, Cypress, etc. +Blitz is the framework for the 99% of us at companies with <100 employees. This means **we don't force you to use advanced technologies like GraphQL**. We let you add advanced technologies on your terms and at your pace. + +Blitz **maximizes your productivity** both when starting an app and when scaling it to lots of code and users. + +
+ +**Features:**
+⚡️ Built on Next.js
+⚡️ Don't have to build an API for client-side rendering
+⚡️ Client-side rendering, Server-side rendering, and fully static pages all in the same app
+⚡️ Full Typescript support with static, end-to-end typing (no code generation step needed like with GraphQL)
+⚡️ React Concurrent Mode enabled
+⚡️ Database/ORM agnostic, but Prisma 2 is default
+⚡️ CLI with code scaffolding, Rails-style console REPL, etc
+⚡️ GraphQL Ready
+⚡️ Deploy serverless or serverful
+ +**Other key features coming:**
+⚡️ Highly secure authentication
+⚡️ Authorization you can use on both server and client
+⚡️ Model validation you can use on both server and client
+⚡️ Plugins for easily adding libaries like Tailwind, CSS-in-JS, etc.
+⚡️ React native support
+⚡️ GUI so you don't have to use the CLI
+ +
+ +### Initial Alpha Release Coming Soon + +We expect an initial alpha release to be ready the week of April 20, 2020. In the meantime, [check out the Architecture RFC](https://github.com/blitz-js/blitz/pull/73) and view the example app here: [`examples/store`](https://github.com/blitz-js/blitz/tree/canary/examples/store)
@@ -33,7 +62,7 @@ Additionally, Blitz is bringing other Rails goodness that’s missing in the Rea Blitz is designed for tiny to large database-backed applications that have one or more graphical user interfaces. -Web support will be released first, followed by React Native. We are pursuing the dream of a single monolithic application that runs on web and mobile with maximum code sharing and minimal boilerplate. +While we currently only support web, we are pursuing the dream of a single monolithic application that runs on web and mobile with maximum code sharing and minimal boilerplate.
@@ -49,23 +78,15 @@ Web support will be released first, followed by React Native. We are pursuing th [The Blitz Manifesto](https://github.com/blitz-js/blitz/blob/canary/MANIFESTO.md) explains these principles in detail. -
- -## Initial Alpha Release Coming Soon - -We expect an initial alpha release to be ready the week of April 20, 2020. In the meantime, [check out the Architecture RFC](https://github.com/blitz-js/blitz/pull/73) and view the example app here: [`examples/store`](https://github.com/blitz-js/blitz/tree/canary/examples/store) - -
## Welcome to the Blitz Community 👋 The Blitz community is warm, safe, diverse, inclusive, and fun! LGBTQ+, women, and minorities are especially welcome. Please read our [Code of Conduct](https://github.com/blitz-js/blitz/blob/canary/CODE_OF_CONDUCT.md). -### You are invited to join us — let’s build the future of web dev together! 🤝 +[Join our Slack Community](https://slack.blitzjs.com) where we help each other build Blitz apps. It's also where collaborate on building Blitz itself. -1. [Join the Blitz Slack Community](https://slack.blitzjs.com) -2. If you're interested in helping, read [The Contributing Guide](CONTRIBUTING.md) +There's still a lot of work to do, so you are especially invited to join us in building Blitz! A good place to start is the [The Contributing Guide](CONTRIBUTING.md).