Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

sharyn

12.0.0-beta.0 • Public • Published
Sharyn logo

🌹 Sharyn

⚠️ Hi :) Don't use the library yet. The documentation is not up-to-date at all.

Sharyn is a library of packages that make your life easier and reduce your boilerplate code. Its Development packages are useful for any project, and the Web ones provide a wide range of tools and helpers for your web app projects.

The default kick-ass tech stack that Sharyn supports is: Babel 7, ESLint 5, Flow, Prettier, Jest, React with server-side rendering, Redux, Webpack with HMR, Material UI, Koa, GraphQL with Apollo, Knex, PostgreSQL, Redis, E2E tests with Puppeteer, Docker, and Heroku. These bricks are all optional and replaceable.

Sharyn will work wonders for projects that follow the upcoming major update of my JS Stack from Scratch tutorial.

🌹 Packages

Development

Web

🌹 Getting Started

To get started, follow the setup tutorial or download the sharyn-boilerplate project.

I recommend the tutorial the first time you use Sharyn, and the boilerplate once you're familiar with the stack.

🌹 Structuring Factor

Every module is tagged with a structuring factor, which represents how easily it can be integrated into an existing codebase. In general, the more structuring and opinionated the modules are, the more they will reduce your boilerplate code, at the cost of flexibility.

🌲 Not structuring – You can use this module in any codebase, it is a very simple unit.

🏠 Moderately structuring – This module has some degree of flexibility, but it serves a more specific purpose than non-structuring ones, so if your need is slightly different, it might be difficult to use it.

🏢 Very structuring – This module is not flexible. It does what it does well, but you have to comply to its purpose or you won't be able to take advantage of it. These are kind of imposing a framework, which is demonstrated by sharyn-boilerplate. If these work for your case, that's a big win!

🌹 Credits

By Jonathan Verrecchia – @verekia

Rose design by tiaesther

🌹 Why Sharyn?

It's a reference to one of my favorite metalcore songs, Rose of Sharyn by Killswitch Engage.

🌹 License

MIT

Keywords

none

Install

npm i [email protected]

Version

12.0.0-beta.0

License

MIT

Unpacked Size

526 kB

Total Files

349

Last publish

Collaborators

  • avatar