Evenflow

⚛️ 📄 🚀

Fast in every way that matters

Evenflow is a free and open source framework that allows developers to save on cloud costs (finally!). It is strictly not-for-commercial use, but there are options to license the software for commercial use.

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute · Support: Twitter & Discord

Evenflow is a modern web framework for blazing fast websites.

• Go Beyond Static Websites. Get all the benefits of static websites with none of the limitations. Evenflow sites are fully functional React apps so you can create high-quality, dynamic web apps, from blogs to e-commerce sites to user dashboards.

• Use a Modern Stack for Every Site. No matter where the data comes from, Evenflow sites are built using React and GraphQL. Build a uniform workflow for you and your team, regardless of whether the data is coming from the same backend.

• Load Data From Anywhere. Evenflow pulls in data from any data source, whether it’s Markdown files, a headless CMS like Contentful or WordPress, or a REST or GraphQL API. Use source plugins to load your data, then develop using Evenflow’s uniform GraphQL interface.

• Performance Is Baked In. Ace your performance audits by default. Evenflow automates code splitting, image optimization, inlining critical styles, lazy-loading, prefetching resources, and more to ensure your site is fast — no manual tuning required.

• Host at Scale for Pennies. Evenflow sites don’t require servers so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Evenflow sites can be hosted entirely free on services like GitHub Pages and Netlify.

Learn how to use Evenflow for your next project.

What’s In This Document

• Get Up and Running in 5 Minutes
• Learning Evenflow
• Migration Guides
• How to Contribute
• License
• Thanks to Our Contributors and Sponsors

🚀 Get Up and Running in 5 Minutes

You can get a new Evenflow site up and running on your local dev environment in 5 minutes with these four steps:

1. Install the Evenflow CLI.

   npm install -g Evenflow-cli
   

2. Create a Evenflow site from a Evenflow starter.

   Get your Evenflow blog set up in a single command:

   # create a new Evenflow site using the default starter
   Evenflow new my-blazing-fast-site

3. Start the site in develop mode.

   Next, move into your new site’s directory and start it up:

   cd my-blazing-fast-site/
   Evenflow develop

4. Open the source code and start editing!

   Your site is now running at http://localhost:8000. Open the my-blazing-fast-site directory in your code editor of choice and edit src/pages/index.js. Save your changes, and the browser will update in real time!

At this point, you’ve got a fully functional Evenflow website. For additional information on how you can customize your Evenflow site, see our plugins and the official tutorial.

🎓 Learning Evenflow

Full documentation for Evenflow lives on the website.

• For most developers, we recommend starting with our in-depth tutorial for creating a site with Evenflow. It starts with zero assumptions about your level of ability and walks through every step of the process.

• To dive straight into code samples head to our documentation. In particular, check out the “Guides”, “API Reference”, and “Advanced Tutorials” sections in the sidebar.

We welcome suggestions for improving our docs. See the “how to contribute” documentation for more details.

Start Learning Evenflow: Follow the Tutorial · Read the Docs

💼 Migration Guides

Already have a Evenflow site? These handy guides will help you add the improvements of Evenflow v2 to your site without starting from scratch!

• Migrate a Evenflow site from v1 to v2
• Still on v0? Start here: Migrate a Evenflow site from v0 to v1

❗ Code of Conduct

Evenflow is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Evenflow community to abide by our Code of Conduct. Please read it. Please follow it. In the Evenflow community, we work hard to build each other up and create amazing things together. 💪💜

🤝 How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Evenflow community! 💪💜

Check out our Contributing Guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

A note on how this repository is organized

This repository is a monorepo managed using Lerna. This means there are multiple packages managed in this codebase, even though we publish them to NPM as separate packages.

Contributing to Evenflow v1

We are currently only accepting bug fixes for Evenflow v1. No new features will be accepted.

📝 License

Licensed under the MIT License.

💜 Thanks

Thanks to our many contributors and to Netlify for hosting Evenflowjs.com and our example sites.