Skip to content
🌹 Sharyn – A library to build modern JavaScript apps
Branch: master
Clone or download
verekia Publish
 - @sharyn/components@4.3.5
 - @sharyn/redux@4.6.3
 - @sharyn/server@6.1.3
 - @sharyn/shared@4.4.0
 - sharyn@11.7.1
Latest commit 7c59831 Jul 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook
docs Add bullets Jul 24, 2018
flow-typed/npm Add examples infrastructure, test for babel-preset, travis Jul 24, 2018
packages Publish Jul 8, 2019
src/stories Upgrade React and MUI Apr 25, 2019
tests Disable eslint test May 24, 2019
.eslintignore Create @sharyn/hocs and hideOnScroll Jul 30, 2018
.eslintrc.js Upgraded check-setup to new syntax Jul 22, 2018
.flowconfig Alpha - First shot at AppWithProviders Sep 26, 2018
.gitignore Create babel-preset-sharyn and eslint-config-sharyn Aug 6, 2018
.mdlintrc.json Add markdownlint Jul 24, 2018
.prettierrc.js Reorganize packages Jul 24, 2018
.travis.yml.off Turn off Travis Sep 21, 2018
README.md Add warning note Sep 26, 2018
babel.config.js WIP - Bump to Babel 56 but without babel-preset test Aug 6, 2018
build.js Add global util Jul 5, 2019
jest.config.js Remove some sharyn dependencies, bump yarn locks Jul 31, 2018
lerna.json Bump to lerna 3.4.3, remove some gitHeads Oct 12, 2018
package.json Upgrade React and MUI Apr 25, 2019
webpack.config.js UI Dev playground, fixed Page Jul 27, 2018
yarn.lock Disable eslint test May 24, 2019

README.md

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

You can’t perform that action at this time.