@backan/core
Advanced tools
Comparing version 0.0.25 to 0.1.0
{ | ||
"name": "@backan/core", | ||
"version": "0.1.0", | ||
"description": "All in one web API builder. Create endpoints with type validations and OpenApi documentation, safely and quickly.", | ||
"version": "0.0.25", | ||
"type": "module", | ||
"license": "GPL-3.0", | ||
"homepage": "https://backan.pigeonposse.com", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/pigeonposse/backan", | ||
"directory": "packages/core" | ||
}, | ||
"publishConfig": { | ||
"access": "public", | ||
"registry": "https://registry.npmjs.org/" | ||
}, | ||
"keywords": [ | ||
@@ -26,8 +14,10 @@ "backend", | ||
], | ||
"files": [ | ||
"dist" | ||
], | ||
"module": "dist/main.js", | ||
"main": "dist/main.js", | ||
"types": "dist/main.d.ts", | ||
"homepage": "https://backan.pigeonposse.com", | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/pigeonposse/backan", | ||
"directory": "packages/core" | ||
}, | ||
"license": "GPL-3.0", | ||
"type": "module", | ||
"exports": { | ||
@@ -37,5 +27,8 @@ ".": "./dist/main.js", | ||
}, | ||
"devDependencies": { | ||
"@hono/vite-dev-server": "0.16.0" | ||
}, | ||
"main": "dist/main.js", | ||
"module": "dist/main.js", | ||
"types": "dist/main.d.ts", | ||
"files": [ | ||
"dist" | ||
], | ||
"dependencies": { | ||
@@ -46,13 +39,20 @@ "@hono/swagger-ui": "0.4.1", | ||
}, | ||
"devDependencies": { | ||
"@hono/vite-dev-server": "0.16.0" | ||
}, | ||
"publishConfig": { | ||
"access": "public", | ||
"registry": "https://registry.npmjs.org/" | ||
}, | ||
"scripts": { | ||
"build": "pnpm run --sequential \"/^build:.*/\"", | ||
"build:lib": "vite build", | ||
"build:rm": "rimraf dist", | ||
"dev": "vite dev", | ||
"dev:node": "tsx examples/app.ts", | ||
"build": "pnpm run --sequential \"/^build:.*/\"", | ||
"build:rm": "rimraf dist", | ||
"build:lib": "vite build", | ||
"lint": "pnpm eslint src", | ||
"test": "pnpm run --sequential \"/^test:.*/\"", | ||
"test:unit": "vitest run src --passWithNoTests", | ||
"test:e2e": "playwright test", | ||
"lint": "pnpm eslint src" | ||
"test:unit": "vitest run src --passWithNoTests" | ||
} | ||
} |
105
README.md
@@ -22,3 +22,2 @@ # 🔥 Backan - Core | ||
<!-- PIGEONPOSSE END HEADER --> | ||
@@ -31,18 +30,17 @@ | ||
- [🔑 Installation](#-installation) | ||
- [Install only `core`](#install-only-core) | ||
- [Setup](#setup) | ||
- [Create `App` instace](#create-app-instace) | ||
- [Create `Route`](#create-route) | ||
- [Add `Endpoints`](#add-endpoints) | ||
- [What is BACKAN?](#what-is-backan) | ||
- [Project intention](#project-intention) | ||
- [Contains](#contains) | ||
- [Todo](#todo) | ||
- [What is `backan` built with?](#what-is-backan-built-with) | ||
- [🏁 Get started with `Backan`](#-get-started-with-backan) | ||
- [🗄️ Get started with `Backan` server](#-get-started-with-backan-server) | ||
- [📦 Build your project](#-build-your-project) | ||
- [🔑 Installation](#-installation) | ||
- [Install only `core`](#install-only-core) | ||
- [Setup](#setup) | ||
- [Create `App` instace](#create-app-instace) | ||
- [Create `Route`](#create-route) | ||
- [Add `Endpoints`](#add-endpoints) | ||
- [What is BACKAN?](#what-is-backan) | ||
- [Project intention](#project-intention) | ||
- [Contains](#contains) | ||
- [Todo](#todo) | ||
- [What is `backan` built with?](#what-is-backan-built-with) | ||
- [🏁 Get started with `Backan`](#-get-started-with-backan) | ||
- [🗄️ Get started with `Backan` server](#-get-started-with-backan-server) | ||
- [📦 Build your project](#-build-your-project) | ||
Start building your restAPI app now 🌈. | ||
@@ -55,8 +53,11 @@ | ||
``` | ||
```bash [pnpm] | ||
pnpm add backan | ||
``` | ||
```bash [yarn] | ||
yarn add backan | ||
``` | ||
```bash [bun] | ||
@@ -68,3 +69,2 @@ bun add backan | ||
### Install only `core` | ||
@@ -75,8 +75,11 @@ | ||
``` | ||
```bash [pnpm] | ||
pnpm add @backan/core | ||
``` | ||
```bash [yarn] | ||
yarn add @backan/core | ||
``` | ||
```bash [bun] | ||
@@ -88,3 +91,2 @@ bun add backan | ||
## Setup | ||
@@ -97,8 +99,11 @@ | ||
``` | ||
```bash [pnpm] | ||
pnpm create backan | ||
``` | ||
```bash [yarn] | ||
yarn create backan | ||
``` | ||
```bash [bun] | ||
@@ -108,5 +113,2 @@ bun create backan | ||
[Read more](https://backan.pigeonposse.com/guide/create/index) | ||
@@ -118,7 +120,7 @@ | ||
## Create `Route` | ||
## Create `Route` | ||
[Read more](https://backan.pigeonposse.com/guide/core/route) | ||
## Add `Endpoints` | ||
## Add `Endpoints` | ||
@@ -186,4 +188,4 @@ - [GET](https://backan.pigeonposse.com/guide/core/get) | ||
- [**`Executables / binaries`**](https://backan.pigeonposse.com/guide/builder/index.md#build-binaries): Create binaries of your project for all **systems** and **architectures** with zero config. | ||
- [**`Client library`**](https://backan.pigeonposse.com/guide/builder/index.md#create-client): Create a client to facilitate the implementation of the API in a frontend or other service. | ||
- [**`Executables / binaries`**](https://backan.pigeonposse.com/guide/builder/index.md#build-binaries): Create binaries of your project for all **systems** and **architectures** with zero config. | ||
- [**`Client library`**](https://backan.pigeonposse.com/guide/builder/index.md#create-client): Create a client to facilitate the implementation of the API in a frontend or other service. | ||
- [**`JSON schema file`**](https://backan.pigeonposse.com/guide/builder/index.md#build-json-types-schema): Export the **OpenAPI schema** to a **JSON file**. | ||
@@ -201,6 +203,6 @@ - [**`TypeScript definitions file`**](https://backan.pigeonposse.com/guide/builder/index.md#build-json-types-schema): Export **OpenAPI schema** to a **d.ts file**. | ||
- [Documentation](https://backan.pigeonposse.com/) | ||
- 📚 [Library](https://backan.pigeonposse.com/guide/core) | ||
- 🏁 [Create (setup)]( https://backan.pigeonposse.com/guide/create ) | ||
- 🗄️ [Server]( https://backan.pigeonposse.com/guide/server ) | ||
- 📦 [Builder]( https://backan.pigeonposse.com/guide/builder ) | ||
- 📚 [Library](https://backan.pigeonposse.com/guide/core) | ||
- 🏁 [Create (setup)]( 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) | ||
@@ -232,3 +234,3 @@ <!-- PIGEONPOSSE END INDEX --> | ||
*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. | ||
_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. | ||
@@ -260,23 +262,19 @@ [![More](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)](https://github.com/pigeonposse) | ||
<!-- | ||
██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗ ██╗ | ||
██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗ ██║ | ||
██████╔╝██║██║ ███╗█████╗ ██║ ██║██╔██╗ ██║ | ||
██╔═══╝ ██║██║ ██║██╔══╝ ██║ ██║██║╚██╗██║ | ||
██║ ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║ | ||
╚═╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═══╝ | ||
██████╗ ██████╗ ███████╗███████╗███████╗ | ||
██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝ | ||
██████╔╝██║ ██║███████╗███████╗█████╗ | ||
██╔═══╝ ██║ ██║╚════██║╚════██║██╔══╝ | ||
██║ ╚██████╔╝███████║███████║███████╗ | ||
╚═╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝ | ||
█████╗█████╗█████╗█████╗█████╗█████╗█████╗ | ||
╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝ | ||
██████╗ ██╗ ██████╗ ███████╗ ██████╗ ███╗ ██╗ | ||
██╔══██╗██║██╔════╝ ██╔════╝██╔═══██╗████╗ ██║ | ||
██████╔╝██║██║ ███╗█████╗ ██║ ██║██╔██╗ ██║ | ||
██╔═══╝ ██║██║ ██║██╔══╝ ██║ ██║██║╚██╗██║ | ||
██║ ██║╚██████╔╝███████╗╚██████╔╝██║ ╚████║ | ||
╚═╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═══╝ | ||
██████╗ ██████╗ ███████╗███████╗███████╗ | ||
██╔══██╗██╔═══██╗██╔════╝██╔════╝██╔════╝ | ||
██████╔╝██║ ██║███████╗███████╗█████╗ | ||
██╔═══╝ ██║ ██║╚════██║╚════██║██╔══╝ | ||
██║ ╚██████╔╝███████║███████║███████╗ | ||
╚═╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝ | ||
█████╗█████╗█████╗█████╗█████╗█████╗█████╗ | ||
╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝╚════╝ | ||
██████╗ █████╗ ██████╗██╗ ██╗ █████╗ ███╗ ██╗ | ||
@@ -288,6 +286,5 @@ ██╔══██╗██╔══██╗██╔════╝██║ ██╔╝██╔══██╗████╗ ██║ | ||
╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═══╝ | ||
REPOSITORY: https://github.com/pigeonposse/backan | ||
AUTHORS: | ||
AUTHORS: | ||
- Angelo (https://github.com/angelespejo) | ||
@@ -294,0 +291,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
81243
282