Skip to content

Commit

Permalink
📝 Edit readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Oleksandr Ratushnyi committed Nov 28, 2022
1 parent 3467cbf commit ba6b738
Show file tree
Hide file tree
Showing 6 changed files with 1,495 additions and 1,303 deletions.
21 changes: 21 additions & 0 deletions LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Merge Development

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
31 changes: 30 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# Merge Development Templates
<br>
<h1 align="center">Merge Templates</h1>

<div align="center">

<p align="center">
<p>Development starting boilerplate from Merge Development</p>
<a align="center" href="https://merge.rocks">
<svg align="center" width="110" height="40" fill="white" xmlns="http://www.w3.org/2000/svg" data-testid="icon" data-name="LogoText" class="TheNavigation_logo__RDs20 TheNavigation_logoDesktop__g9Yvy"><path d="M104.554 10.986c0-1.292-.268-2.45-.805-3.42a5.51 5.51 0 00-2.282-2.288c-.994-.539-2.068-.808-3.303-.808-1.235 0-2.363.27-3.356.835-.994.565-1.772 1.32-2.336 2.316-.564.996-.832 2.1-.832 3.339 0 1.238.295 2.37.859 3.366.564.996 1.396 1.75 2.443 2.315 1.047.566 2.282.835 3.652.835 1.1 0 2.067-.161 2.926-.511.779-.324 1.423-.755 1.96-1.32.108-.108.108-.296 0-.43l-1.208-1.374c-.107-.135-.295-.135-.429-.027-.86.78-1.934 1.158-3.196 1.158-1.1 0-1.987-.27-2.738-.808-.725-.538-1.182-1.293-1.37-2.208h9.908c.081-.485.107-.781.107-.97zm-9.988-1.104c.134-.942.537-1.669 1.182-2.235.644-.565 1.45-.834 2.39-.834.966 0 1.771.296 2.416.861.644.566 1.02 1.32 1.154 2.235h-7.142v-.027zM42.289 4.416c-.994 0-1.906.189-2.712.566a5.292 5.292 0 00-2.014 1.561 4.158 4.158 0 00-1.745-1.588c-.725-.35-1.584-.539-2.524-.539-.859 0-1.664.162-2.363.458a4.725 4.725 0 00-1.772 1.292V4.551h-2.497a.298.298 0 00-.295.296v12.037c0 .161.134.296.295.296h2.336a.298.298 0 00.296-.296v-6.086c0-1.239.295-2.181.886-2.827.59-.647 1.396-.97 2.39-.97.912 0 1.61.27 2.093.835.484.565.726 1.4.726 2.504v6.57c0 .162.134.297.295.297h2.336a.298.298 0 00.295-.296v-6.113c0-1.212.296-2.154.886-2.8.59-.647 1.396-.997 2.39-.997.913 0 1.61.27 2.094.835.483.565.725 1.4.725 2.504v6.57c0 .162.134.297.296.297h2.335a.299.299 0 00.296-.296V9.99c0-1.859-.457-3.232-1.396-4.175-.78-.915-2.041-1.4-3.652-1.4zM60.171 5.25c-.966-.538-2.067-.807-3.302-.807-1.236 0-2.363.27-3.357.835-.993.565-1.772 1.32-2.336 2.316-.564.996-.832 2.1-.832 3.339 0 1.238.295 2.37.86 3.366.563.996 1.395 1.75 2.443 2.315 1.047.566 2.282.835 3.651.835 1.101 0 2.068-.161 2.927-.511.779-.324 1.423-.754 1.96-1.32.107-.108.107-.296 0-.43l-1.208-1.374c-.108-.135-.296-.135-.43-.027-.86.78-1.933 1.158-3.195 1.158-1.101 0-1.987-.27-2.739-.808-.752-.539-1.181-1.293-1.37-2.208h9.908c.027-.377.054-.673.054-.889 0-1.292-.268-2.45-.805-3.42a5.291 5.291 0 00-2.229-2.37zm-6.9 4.632c.134-.942.537-1.669 1.181-2.235.645-.565 1.45-.834 2.39-.834.966 0 1.772.296 2.416.861.645.566 1.02 1.32 1.155 2.235H53.27v-.027zM73.435 4.443c-1.96.054-3.356.727-4.162 1.993V4.9a.298.298 0 00-.295-.296h-2.202a.298.298 0 00-.295.296v12.037c0 .161.134.296.295.296h2.336a.298.298 0 00.296-.296v-5.844c0-1.265.322-2.235.966-2.908.645-.673 1.558-.996 2.685-.996.215 0 .43.027.698.08V4.767a.285.285 0 00-.322-.323zM88.66 4.578h-2.203a.298.298 0 00-.295.296v1.373a4.552 4.552 0 00-1.88-1.373 6.759 6.759 0 00-2.496-.458c-1.209 0-2.283.243-3.25.754-.966.512-1.745 1.212-2.282 2.154-.564.916-.832 1.993-.832 3.178 0 1.212.269 2.262.832 3.204a5.744 5.744 0 002.283 2.181c.966.512 2.04.781 3.248.781.86 0 1.665-.134 2.39-.43.725-.297 1.343-.7 1.853-1.266v.673c0 1.293-.322 2.262-.967 2.881-.644.62-1.665.943-3.06.943-.86 0-1.72-.135-2.578-.404a7.222 7.222 0 01-1.826-.889c-.134-.107-.35-.08-.43.081l-1.02 1.696c-.08.135-.054.324.08.404.672.512 1.504.889 2.47 1.158 1.102.296 2.23.458 3.464.458 4.538 0 6.82-2.235 6.82-6.678V4.874c0-.162-.134-.296-.322-.296zm-3.68 8.563c-.724.673-1.637.996-2.765.996-1.128 0-2.067-.323-2.765-.996-.725-.673-1.074-1.535-1.074-2.612 0-1.05.349-1.912 1.074-2.585.724-.673 1.637-.997 2.765-.997 1.128 0 2.04.324 2.766.997.725.673 1.074 1.535 1.074 2.585 0 1.077-.35 1.939-1.074 2.612zM8.578 1.64a.217.217 0 00-.218-.22H5.854a.217.217 0 00-.218.22v12.397L.064 19.64a.213.213 0 000 .304l1.755 1.774c.085.085.218.085.315 0l6.372-6.43a.232.232 0 00.06-.157l.012-13.492zM12.244 21.72l-2.892-2.892a.21.21 0 010-.301l1.766-1.772c.085-.084.218-.084.315 0l2.88 2.892a.21.21 0 010 .302l-1.755 1.76a.217.217 0 01-.314.011z"></path><path d="M12.21 9.17L7.335 4.275a.229.229 0 00-.318 0L2.154 9.17a.229.229 0 01-.318 0L.064 7.388a.214.214 0 010-.306L7.03.064a.229.229 0 01.318 0l6.965 7.006a.214.214 0 010 .305L12.54 9.17c-.097.085-.244.085-.33 0z"></path></svg>
</a>
</p>

</div>
<br>

## [🚀 Next.js + Tailwind + Storybook + Vitest + Airbnb Eslint](https://github.com/mergerocks/merge-template/next-tailwind)
```bash
npx degit mergerocks/merge-template/next-tailwind my-new-project
```

<br>



<br>
<hr>
<br>

## License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/parcel-bundler/parcel/blob/v2/LICENSE) file for details
1 change: 1 addition & 0 deletions next-tailwind/.husky/pre-commit
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npm lint
npm test
55 changes: 40 additions & 15 deletions next-tailwind/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,71 +5,96 @@
<tr>
<th>Name</th>
<th>Version</th>
<th>Link</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Next.js</td>
<td>
<a href="https://nextjs.org/" target="_blank">Next.js</a>
</td>
<td><code>13.0.1</code></td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>Typescript</td>
<td>
<a href="https://www.typescriptlang.org/" target="_blank">Typescript</a>
</td>
<td><code>4.8.4</code></td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>Tailwindcss</td>
<td>
<a href="https://tailwindcss.com/" target="_blank">Tailwind</a>
</td>
<td><code>^3.2.1</code></td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>Vitest</td>
<td>
<a href="https://vitest.dev/" targe="_blank">Vitest</a>
</td>
<td><code>^0.24.5</code></td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>Eslint</td>
<td>
<a href="https://eslint.org/" target="_blank">Eslint</a>
</td>
<td><code>8.26.0</code></td>
<td>-</td>
<td>-</td>
<td>Airbnb rules</td>
</tr>
<tr>
<td>Storybook</td>
<td>
<a href="https://storybook.js.org/" target="_blank">Storybook</a>
</td>
<td><code>^6.5.13</code></td>
<td>-</td>
<td>-</td>
</tr>
<tr>
<td>
<a href="https://www.npmjs.com/package/clsx" target="_blank">clsx</a>
</td>
<td><code>^1.2.1</code></td>
<td>classNames merging</td>
</tr>
</tbody>
</table>
<br>


## ⚙️ Install


```bash
npx degit mergerocks/merge-template/next-tailwind my-new-project
```

**🥋 Required VS Code Plugin**: [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss)
<br>
<br>


## Development:

```bash
yarn dev
```

## Run linter:

```bash
yarn lint
```

## Production build:
## Production build:

```bash
yarn build
```

## Production start:

```bash
yarn start
```
5 changes: 4 additions & 1 deletion next-tailwind/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
"build": "next build",
"start": "next start",
"lint": "next lint",
"prepare": "husky install",
"husky:install": "husky install",
"git:install": "git init",
"prepare": "run-s git:install husky:install",
"test:watch": "vitest",
"test": "vitest run",
"storybook": "start-storybook -p 6006",
Expand Down Expand Up @@ -44,6 +46,7 @@
"eslint-config-next": "13.0.1",
"husky": "^7.0.0",
"jsdom": "^20.0.2",
"npm-run-all": "^4.1.5",
"postcss": "^8.4.18",
"storybook-css-modules": "^1.0.8",
"tailwindcss": "^3.2.1",
Expand Down
Loading

0 comments on commit ba6b738

Please sign in to comment.