Skip to content

Commit

Permalink
Merge pull request #22 from Entermedia-LLC/main
Browse files Browse the repository at this point in the history
Preparing for beta release
  • Loading branch information
bmarshall511 authored Feb 1, 2023
2 parents 1e1de11 + 63b366e commit 1320142
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@

A Next.js 13 CMS-agnostic starter application to build fully-featured headless sites with built-in support for WordPress.

## Introduction

This project is in **beta** and under **active development** — not ready for use for production. Our first release is intended to give basic functionality, standardization & WordPress integration. Our goal is to create a Next.js starter framework that:

* isn't dependent on a particular theming framework — setup theming how you like
* is CMS-agnostic with baked in support for WordPress, Drupal & Shopify
* provides out-of-the-box support for [SCSS](https://sass-lang.com/)
* built-in [Storybook](https://storybook.js.org/) integration
* helps enforce coding standards with [Stylelint](https://stylelint.io/), [TypeScript](https://www.typescriptlang.org/) & [commitlint](https://commitlint.js.org/#/)
- isn't dependent on a particular theming framework — setup theming how you like
- optional support for [Gutenberg Ant Design blocks](https://github.com/Entermedia-LLC/wordpress-gutenberg-ant-design)
- is CMS-agnostic with baked in support for WordPress, Drupal & Shopify
- provides out-of-the-box support for [SCSS](https://sass-lang.com/)
- built-in [Storybook](https://storybook.js.org/) integration
- helps enforce coding standards with [Stylelint](https://stylelint.io/), [TypeScript](https://www.typescriptlang.org/) & [commitlint](https://commitlint.js.org/#/)

## Documentation

Expand All @@ -20,16 +17,16 @@ Visit https://github.com/Highfivery/nextjs-starter/wiki to view all the document

There are many ways to [contribute](https://github.com/Highfivery/nextjs-starter/blob/main/CONTRIBUTING.md) to this project:

* Discuss [open issues](https://github.com/Highfivery/nextjs-starter/blob/main/issues) to help define the future of the project
* [Submit bugs](https://github.com/Highfivery/nextjs-starter/issues) and help verify fixes
* Review and discuss [pull requests](https://github.com/Highfivery/nextjs-starter/pulls)
* Level up the [documentation](https://github.com/Highfivery/nextjs-starter/wiki)
* Monitor and help answer questions in [Github Discussions](https://github.com/Highfivery/nextjs-starter/discussions)
- Discuss [open issues](https://github.com/Highfivery/nextjs-starter/blob/main/issues) to help define the future of the project
- [Submit bugs](https://github.com/Highfivery/nextjs-starter/issues) and help verify fixes
- Review and discuss [pull requests](https://github.com/Highfivery/nextjs-starter/pulls)
- Level up the [documentation](https://github.com/Highfivery/nextjs-starter/wiki)
- Monitor and help answer questions in [Github Discussions](https://github.com/Highfivery/nextjs-starter/discussions)

## Special Thanks

* [WebDevStudios](https://github.com/WebDevStudios) for their work on [nextjs-wordpress-starter](https://github.com/WebDevStudios/nextjs-wordpress-starter) (since abandoned) giving us a great start for WordPress integration.
* Development team at [Entermedia](https://www.entermedia.com/) for their work on the default starter components & [minimal CSS framework](https://github.com/Entermedia-LLC/scss).
- [WebDevStudios](https://github.com/WebDevStudios) for their work on [nextjs-wordpress-starter](https://github.com/WebDevStudios/nextjs-wordpress-starter) (since abandoned) giving us a great start for WordPress integration.
- Development team at [Activated Studio](https://www.activated.studio/) for their work on the default starter components, [minimal CSS framework](https://github.com/Entermedia-LLC/scss) & the [Gutenberg Ant Design plugin](https://github.com/Entermedia-LLC/wordpress-gutenberg-ant-design).

## License

Expand Down

1 comment on commit 1320142

@vercel
Copy link

@vercel vercel bot commented on 1320142 Feb 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.