@bootcamp-project/rollupjs-config
Version:
Ready-to-use Rollup Configuration with TypeScript, Svelte, Tailwind CSS support by default, for AMD, UMD, CJS, ESM
150 lines (108 loc) • 6.08 kB
Markdown
<!--
MIT License
Copyright (c) 2021 Bootcamp-Project contributors <contributors@bootcamp-project.com>
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.
-->
<a href="https://bootcamp-project.com/" target="_blank"><img src="https://bootcamp-project.com/tbcp.svg" align="right" height="200" /></a>
# Ready-to-use Rollup Configuration
## with TypeScript, Svelte, Tailwind CSS support by default, for AMD, UMD, CJS, ESM
<img src="https://img.shields.io/npm/v/@bootcamp-project/rollupjs-config?style=for-the-badge">
<img src="https://img.shields.io/librariesio/release/npm/@bootcamp-project/rollupjs-config?style=for-the-badge">
<img src="https://img.shields.io/badge/License-MIT-lightgrey?style=for-the-badge" />
<img src="https://img.shields.io/badge/Bootcamp-Project-blue?style=for-the-badge" />
## 🦄 About 🦄
> Description
**Project Links**
- [Homepage][Repo_Homepage]
- [Repository][Repo_URL]
- [Documentation][Repo_Docs]
- [Issues][Repo_Issues]
**Minimum Viable Product**: *What is what we want?*
- **What are the goals?**
- [ ] Goal #1
- [ ] Goal #2
- [ ] Goal #3
- **Sense** *(Why do these goals exist?)*
- [ ] Explanation #1
- [ ] Explanation #2
- [ ] Explanation #3
- **Purpose** *(What should be done with it?)*
- [ ] Use Case #1
- [ ] Use Case #2
- [ ] Use Case #3
## 🚀 Getting Started 🚀
### 💪 Installation 💪
```bash
npm install --safe-dev rollup @bootcamp-project/rollupjs-config
# or
yarn add --dev rollup @bootcamp-project/rollupjs-config
```
### 🤩 Usage 🤩
```js
// rollup.config.js
'use strict';
const RollupConfig = require('@bootcamp-project/rollupjs-config/rollup.config')
module.exports = RollupConfig
```
## ⭐️ Features ⭐️
<!--
- [**Svelte** UI Library and **Tailwind CSS**](https://gitlab.com/the-bootcamp-project/libraries/svelte-components) by default
- **Automatic CI/CD Pipeline** for **GitLab** by default
-->
- Latest preinstalled **Dependencies** by default
- [**Security-first production ready configuration**][TBCP_Configurations] by default
- [Extensive configuration **documentation**][Repo_Docs]
### 😎 Built With 😎
<table>
<tr>
<td><a href="https://rollupjs.org/" target="_blank"><img src="https://cdr.bootcamp-project.com/logos/programming/rollup.svg" alt="Rollup" width="200"/></a></td>
<td><a href="https://developer.mozilla.org/" target="_blank"><img src="https://cdr.bootcamp-project.com/logos/programming/javascript.svg" alt="JavaScript" width="200"/></a></td>
<td><a href="https://typescriptlang.org/" target="_blank"><img src="https://cdr.bootcamp-project.com/logos/programming/typescript.svg" alt="TypeScript" width="200"/></a></td>
<td><a href="https://svelte.dev/" target="_blank"><img src="https://cdr.bootcamp-project.com/logos/programming/svelte.svg" alt="Svelte" width="200"/></a></td>
<td><a href="https://tailwindcss.com/" target="_blank"><img src="https://cdr.bootcamp-project.com/logos/programming/tailwindcss.svg" alt="Tailwind CSS" width="200"/></a></td>
<td><a href="https://bootcamp-project.com/" target="_blank"><img src="https://bootcamp-project.com/tbcp.svg" alt="tbcp" width="200"/></a></td>
</tr>
</table>
## 📑 Changelog 📑
See [CHANGELOG](CHANGELOG) for more information.
## 📋 Roadmap 📋
See the [open issues][Repo_Issues] for a list of proposed features (and known issues).
## 🤝 Contribute 🤝
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Please read the [contribution guidelines][TBCP_Contribution] first.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 🏆 Acknowledgements 🏆
Thanks for these awesome resources that were used during the development of the **Bootcamp: Library Project Structure**:
- [rollup.js](https://rollupjs.org)
## 📜 License 📜
See [LICENSE](LICENSE) for more information.
## 💌 Contact 💌
[Bootcamp contributors][TBCP_Homepage] - `contributors` @ `bootcamp-project` .com
<!-- ---------------------------------------------------------------------------------------------------------------------------------- -->
<!-- ---------------------------------------------------------------------------------------------------------------------------------- -->
<!-- ---------------------------------------------------------------------------------------------------------------------------------- -->
[Repo_Homepage]: https://configurations.bootcamp-project.com/#/bundling/rollup
[Repo_URL]: https://gitlab.com/the-bootcamp-project/configurations/rollup
[Repo_Docs]: https://configurations.bootcamp-project.com/#/bundling/rollup
[Repo_Issues]: https://gitlab.com/the-bootcamp-project/configurations/rollup/-/issues
[TBCP_Configurations]: https://configurations.bootcamp-project.com
[TBCP_Contribution]: https://bootcamp-project.com/#code_of_conduct
[TBCP_Homepage]: https://bootcamp-project.com