Skip to content

Commit

Permalink
Deployed 9aff91a with MkDocs version: 1.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Hallett committed Jul 20, 2023
1 parent 16fe0dc commit 4f0ef61
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 8 deletions.
60 changes: 53 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,11 +221,25 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#build-type-safe-python-and-typescript-applications" class="md-nav__link">
Build type safe Python and TypeScript applications
</a>

</li>

<li class="md-nav__item">
<a href="#built-on-popular-tools" class="md-nav__link">
Built on popular tools
</a>

</li>

<li class="md-nav__item">
<a href="#type-safe-productivity-boost" class="md-nav__link">
Type-safe productivity boost
</a>

</li>

</ul>
Expand Down Expand Up @@ -307,11 +321,25 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#build-type-safe-python-and-typescript-applications" class="md-nav__link">
Build type safe Python and TypeScript applications
</a>

</li>

<li class="md-nav__item">
<a href="#built-on-popular-tools" class="md-nav__link">
Built on popular tools
</a>

</li>

<li class="md-nav__item">
<a href="#type-safe-productivity-boost" class="md-nav__link">
Type-safe productivity boost
</a>

</li>

</ul>
Expand All @@ -330,17 +358,35 @@


<h1 id="beckett-framework">💫 Beckett Framework</h1>
<p><em>The Framework for Building strictly-typed Python and React TypeScript Websites</em></p>
<h3 id="build-type-safe-python-and-typescript-applications">Build type safe Python and TypeScript applications</h3>
<p><img alt="Beckett maze" src="banner.jpg" /></p>
<p>Welcome to Beckett, a strictly-typed Flask and React TypeScript application template.</p>
<p>Beckett combines a <a href="https://flask.palletsprojects.com/en/2.3.x/">Flask</a> server, with a robust <a href="https://www.typescriptlang.org/docs/handbook/react.html">React TypeScript</a> UI, to provide a comprehensive full stack framework.</p>
<p>Beckett features a sophisticated types manager that automatically synchronizes <a href="https://docs.python.org/3/library/typing.html">Python Type hints</a> and <a href="https://www.typescriptlang.org/docs/handbook/interfaces.html">TypeScript interfaces</a>. This means that as you make changes to your code, Beckett diligently keeps the API interface in perfect harmony.</p>
<p>While Beckett is strongly opinionated, it significantly enhances productivity by providing a cohesive development experience and reducing the time spent on manual synchronization between frameworks.</p>
<p>Welcome to Beckett, a <em>strongly-linked</em> Flask and React application template.</p>
<p>Beckett combines a <a href="https://flask.palletsprojects.com/en/2.3.x/">Flask</a> server, with a <a href="https://www.typescriptlang.org/docs/handbook/react.html">React TypeScript</a> UI into a comprehensive full-stack framework for building modern web applications.</p>
<p>Beckett features a sophisticated types manager that automatically synchronizes <a href="https://docs.python.org/3/library/typing.html">Python Type hints</a> and <a href="https://www.typescriptlang.org/docs/handbook/interfaces.html">TypeScript interfaces</a>. This means that as you make changes to your API code in the server, Beckett diligently keeps the API Client up to date.</p>
<p><img alt="beckett features" src="diagram.jpg" /></p>
<h2 id="built-on-popular-tools">Built on popular tools</h2>
<p>We use cutting edge Python tools including:</p>
<ul>
<li><a href="https://docs.pydantic.dev/latest/">Pydantic 2.0</a></li>
<li><a href="https://flask.palletsprojects.com/en/2.3.x/">Flask 2.3</a></li>
</ul>
<p>And our TypeScript is modern too:</p>
<ul>
<li><a href="https://nodejs.org/en">Node 18.17.0</a></li>
<li><a href="https://react.dev/">React 18</a></li>
<li><a href="https://www.typescriptlang.org/">TypeScript 5.1</a></li>
</ul>
<p>Both TypeScript and Python hold their positions as two of the <a href="https://www.statista.com/statistics/793628/worldwide-developer-survey-most-used-languages/">most widely used programming languages globally</a>. As a result, they are frequently combined in various projects.</p>
<p>However, setting up a smooth and efficient development environment that integrates these languages can be a cumbersome and time-consuming process, often leading to a subpar developer experience.</p>
<p>Thankfully, Beckett steps in to solve this challenge by through it's sophisticated types manager.</p>
<p>However, setting up a smooth and efficient development environment that integrates these languages can be a cumbersome and time-consuming process, often leading to a subpar developer experience. Thankfully, Beckett steps in to solve this challenge by through it's sophisticated types manager.</p>
<h2 id="type-safe-productivity-boost">Type-safe productivity boost</h2>
<p>Beckett provides:</p>
<ul>
<li>A types manager which keeps the API interface type-safe.</li>
<li>React: A collection of type-safe API hooks for querying the HTTP API.</li>
<li>React: No single page app, so bundled JS for the client loads faster.</li>
<li>Flask: A manager for generating new React pages without any manual effort.</li>
<li>Flask: View-based routing to reduce the bundle size of JS on page loads.</li>
</ul>
<p>Wanna learn more? Start with the <a href="/install/">install step</a> to get started.</p>


Expand Down
Loading

0 comments on commit 4f0ef61

Please sign in to comment.