diff --git a/.dev/templates/readme.mjs b/.dev/templates/readme.mjs index 594c665..6559ab8 100644 --- a/.dev/templates/readme.mjs +++ b/.dev/templates/readme.mjs @@ -82,8 +82,9 @@ const index = pkg => { return ` - [Documentation](${pkg.data.homepage}) - 📙 [Library](${joinUrl( pkg.data.homepage, pkg.data.extra.docsPath.core )}) + - 🏁 [Create]( ${joinUrl( pkg.data.homepage, pkg.data.extra.docsPath.create )} ) - 🖥️ [Server]( ${joinUrl( pkg.data.homepage, pkg.data.extra.docsPath.server )} ) - - 🐳 [Builder]( ${joinUrl( pkg.data.homepage, pkg.data.extra.docsPath.builder )} ) + - 📦 [Builder]( ${joinUrl( pkg.data.homepage, pkg.data.extra.docsPath.builder )} ) - [Installation](${joinUrl( pkg.data.homepage, pkg.data.extra.docsPath.core, '#installation' )})` } diff --git a/README.md b/README.md index 4ea7190..fcd4f5b 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation) diff --git a/packages/_config/README.md b/packages/_config/README.md new file mode 100644 index 0000000..3e9ae3d --- /dev/null +++ b/packages/_config/README.md @@ -0,0 +1,121 @@ +# Backan - Config + +> This package contains **_BACKAN_** config for monorepo + + + +[![HEADER](https://raw.githubusercontent.com/pigeonposse/backan/main/docs/public/banner.png)](https://backan.pigeonposse.com/) + +[![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com) +[![About Us](https://img.shields.io/badge/About%20Us-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com?popup=about) +[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge&logoColor=white)](https://pigeonposse.com/?popup=donate) +[![Github](https://img.shields.io/badge/Github-black?style=for-the-badge&logo=github&logoColor=white)](https://github.com/pigeonposse) +[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/pigeonposse_) +[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/pigeon.posse/) +[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@pigeonposse) + +[![License](https://img.shields.io/github/license/pigeonposse/backan-monorepo?color=green&style=for-the-badge&logoColor=white)](/LICENSE) +[![Version](https://img.shields.io/npm/v/backan?color=blue&style=for-the-badge&label=Version)](https://www.npmjs.com/package/backan) + +Create endpoints with type validations and OpenApi documentation, safely and quickly. + + + + + + +- [Documentation](https://backan.pigeonposse.com/) + - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) + - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) +- [Installation](https://backan.pigeonposse.com/guide/core/#installation) + + + +## 👨‍💻 Development + +**BACKAN** is an open-source project and its development is open to anyone who wants to participate. + +[![Issues](https://img.shields.io/badge/Issues-grey?style=for-the-badge)](https://github.com/pigeonposse/backan/issues) +[![Pull requests](https://img.shields.io/badge/Pulls-grey?style=for-the-badge)](https://github.com/pigeonposse/backan/pulls) +[![Read more](https://img.shields.io/badge/Read%20more-grey?style=for-the-badge)](https://backan.pigeonposse.com/) + +## ☕ Donate + +Help us to develop more interesting things. + +[![Donate](https://img.shields.io/badge/Donate-grey?style=for-the-badge)](https://pigeonposse.com/?popup=donate) + +## 📜 License + +This software is licensed with **[GPL-3.0](/LICENSE)**. + +[![Read more](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)](/LICENSE) + +## 🐦 About us + +*PigeonPosse* is a ✨ **code development collective** ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects. + +[![More](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)](https://github.com/pigeonposse) + +### Collaborators + +| | Name | Role | GitHub | +| ---------------------------------------------------------------------------------- | ----------- | ------------ | ---------------------------------------------- | +| Angelo | Angelo | Author & Development | [@Angelo](https://github.com/angelespejo) | +| PigeonPosse | PigeonPosse | Collective | [@PigeonPosse](https://github.com/PigeonPosse) | + +
+

+ +[![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com) +[![About Us](https://img.shields.io/badge/About%20Us-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com?popup=about) +[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge&logoColor=white)](https://pigeonposse.com/?popup=donate) +[![Github](https://img.shields.io/badge/Github-black?style=for-the-badge&logo=github&logoColor=white)](https://github.com/pigeonposse) +[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/pigeonposse_) +[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logo=instagram&logoColor=white)](https://www.instagram.com/pigeon.posse/) +[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@pigeonposse) + +

+ + + + + diff --git a/packages/backan/README.md b/packages/backan/README.md index a9b4ea4..675614a 100644 --- a/packages/backan/README.md +++ b/packages/backan/README.md @@ -1,4 +1,7 @@ -# Backan - All in one web API builder +# 🔥 Backan - Core + +All in one web API builder. +Create endpoints with type validations and OpenApi documentation, safely and quickly @@ -24,8 +27,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation) diff --git a/packages/builder/README.md b/packages/builder/README.md index 3f28225..c6378f4 100644 --- a/packages/builder/README.md +++ b/packages/builder/README.md @@ -26,8 +26,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation) diff --git a/packages/core/README.md b/packages/core/README.md index 38598a3..864d123 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,4 +1,7 @@ -# Backan - All in one web API builder +# 🔥 Backan - Core + +**All in one web API builder**. +Create endpoints with type validations and OpenApi documentation, safely and quickly @@ -26,8 +29,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation) diff --git a/packages/create/README.md b/packages/create/README.md index b0b5026..895eaf1 100644 --- a/packages/create/README.md +++ b/packages/create/README.md @@ -26,8 +26,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation) diff --git a/packages/docs/README.md b/packages/docs/README.md index 5e82915..e207ce7 100644 --- a/packages/docs/README.md +++ b/packages/docs/README.md @@ -26,8 +26,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation) diff --git a/packages/server/README.md b/packages/server/README.md index 217f837..c325a52 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -26,8 +26,9 @@ Create endpoints with type validations and OpenApi documentation, safely and qui - [Documentation](https://backan.pigeonposse.com/) - 📙 [Library](https://backan.pigeonposse.com/guide/core) + - 🏁 [Create]( https://backan.pigeonposse.com/guide/create ) - 🖥️ [Server]( https://backan.pigeonposse.com/guide/server ) - - 🐳 [Builder]( https://backan.pigeonposse.com/guide/builder ) + - 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) - [Installation](https://backan.pigeonposse.com/guide/core/#installation)