@backan/core

v0.0.25

All in one web API builder. Create endpoints with type validations and OpenApi documentation, safely and quickly. For more information about how to use this package see README

Latest version published 3 months ago

License: GPL-3.0

NPM

GitHub

Package Health Score

62 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.0.25	\|	09/2024		0 C 0 H 0 M 0 L	1 H 0 M 0 L

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (4)

GitHub Stars: 2
Forks: 0
Contributors: 2

Direct Usage Popularity

The npm package @backan/core receives a total of 4 downloads a week. As such, we scored @backan/core popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @backan/core, we found that it has been starred 2 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 2
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 3 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of @backan/core based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @backan/core demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 months
Dependencies: 3 Direct
Versions: 19
Install Size: 81.8 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: No

@backan/core has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

🔥 Backan - Core

All in one web API builder.

BACKAN Create endpoints with type validations and OpenApi documentation, safely and quickly.

> This package contains BACKAN Core library

Start building your restAPI app now 🌈.

🔑 Installation

npm install backan

pnpm add backan

yarn add backan

bun add backan

Install only `core`

npm install @backan/core

pnpm add @backan/core

yarn add @backan/core

bun add backan

Setup

You can automatically create a backan template with:

npm create backan

pnpm create backan

yarn create backan

bun create backan

Create `App` instace

Create `Route`

What is BACKAN?

BACKAN is a library designed to build REST API applications quickly and easily.

> [!IMPORTANT] > Currently in phase Beta > The library can be used perfectly in production, but could undergo changes and new features until version 1. > To avoid ongoing maintenance issues, we recommend installing a fixed version (without ^) in your project.

Project intention

Our project is not intended to be a substitute for any web framework. Our library aims to cover a specific use case, that of building APIs, simplifying this process as much as possible and creating APIs in a robust way.

The creation of this project is also due to the need of our collective to create APIs with good documentation and in a simple way, an example of this is the Api section of bepp (a web extension packager).

Contains

✅ Simple data validation, so that your endpoints are as secure as possible and reduce repetitive code (boilerplate).
✅ Built-in and almost automatic OpenAPI documentation, improving the visibility of our API without the need to import other projects.

In addition, BACKAN also provides:

A backan project creator with templates of greater and lesser complexity. Read more
Configuration to create your Node server, perfect for running your application without having to configure anything. Read more
Tool to build the binary of your application, ideal for running the app without the need for a Node.js environment. Read more

> [!note] > The documentation is under construction. Soon, we will write all the points it contains

Todo

💡 Typing for make your frontend projects more easy.

What is `backan` built with?

Our library is built under the hono framework, which is why you will see references to it in our documentation and our code. BACKAN is an implementation that aims to simplify the construction of apirest for specific use cases.

You want to build an apirest quickly and safely and without thinking about third-party implementations, well here we propose our alternative.

🏁 Get started with `Backan`

Start building your restAPI app now 🌈.

🗄️ Get started with `Backan` server

📦 Build your project

The backan builder library allows you to build multiple things. Among others:

Executables / binaries: Create binaries of your project for all systems and architectures with zero config.
Client library: Create a client to facilitate the implementation of the API in a frontend or other service.
JSON schema file: Export the OpenAPI schema to a JSON file.
TypeScript definitions file: Export OpenAPI schema to a d.ts file.
Markdown documentation: Build your application documentation in a Markdown file.

Documentation
- 📚 Library
- 🏁 Create (setup)
- 🗄️ Server
- 📦 Builder
Installation

👨‍💻 Development

BACKAN is an open-source project and its development is open to anyone who wants to participate.

☕ Donate

Help us to develop more interesting things.

📜 License

This software is licensed with GPL-3.0.

🐦 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.

Collaborators

	Name	Role	GitHub
	Angelo	Author & Development	@Angelo
	PigeonPosse	Collective	@PigeonPosse

@backan/core dependencies

@hono/swagger-ui @hono/zod-openapi hono

@backan/core development dependencies

@hono/vite-dev-server

FAQs

What is @backan/core?

All in one web API builder. Create endpoints with type validations and OpenApi documentation, safely and quickly. Visit Snyk Advisor to see a full health score report for @backan/core, including popularity, security, maintenance & community analysis.

Is @backan/core popular?

The npm package @backan/core receives a total of 4 weekly downloads. As such, @backan/core popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @backan/core well maintained?

We found that @backan/core demonstrated a healthy version release cadence and project activity. It has a community of 2 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @backan/core safe to use?

While scanning the latest version of @backan/core, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 16 November-2024, at 22:04 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP