README.md

NextJS . TypeScript . Storybook Boilerplate

A boilerplate to speed up your development first hit 🎉

What is inside

1. NextJS
2. TypeScript
3. Storybook
4. Emotion (Styled component)
5. Testing with Jest [ to do ]

Structure

   ...
   ├── .storybook                   # Storybook configuration
   ├── components                   # Project's components
   ├── utils                        # themes, and other project's related utils
   ├── pages                        # Project pages (routes)
   ├── .babelrc
   ├── .editorconfig
   ├── .gitignore
   ├── next.config.js
   ├── package.json
   ├── prettier.config.js
   ├── README.md
   ├── tsconfig.json
   └── tslint.json
   ...

Installation

git clone https://github.com/OmarZeidan/nextjsboilerplate.git your_project_name

Setup

# Make sure you have yarn installed.
yarn install

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

TODO

• Install Jest for testing
• Add Emotion theme as a context API
• Add simple component for Storybook.
• Snapshot test for a simple component