https://github.com/alessiofrittoli/next-api
Next.js server TypeScript API utility library
https://github.com/alessiofrittoli/next-api
next-api nextjs
Last synced: about 2 months ago
JSON representation
Next.js server TypeScript API utility library
- Host: GitHub
- URL: https://github.com/alessiofrittoli/next-api
- Owner: alessiofrittoli
- License: mit
- Created: 2024-12-20T11:16:14.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-03-24T17:42:36.000Z (2 months ago)
- Last Synced: 2025-03-24T17:53:17.646Z (2 months ago)
- Topics: next-api, nextjs
- Language: TypeScript
- Homepage: https://npmjs.com/package/@alessiofrittoli/next-api
- Size: 436 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Next.js API utilities △
[![NPM Latest Version][version-badge]][npm-url] [![Coverage Status][coverage-badge]][coverage-url] [![Socket Status][socket-badge]][socket-url] [![NPM Monthly Downloads][downloads-badge]][npm-url] [![Dependencies][deps-badge]][deps-url]
[![GitHub Sponsor][sponsor-badge]][sponsor-url]
[version-badge]: https://img.shields.io/npm/v/%40alessiofrittoli%2Fnext-api
[npm-url]: https://npmjs.org/package/%40alessiofrittoli%2Fnext-api
[coverage-badge]: https://coveralls.io/repos/github/alessiofrittoli/next-api/badge.svg
[coverage-url]: https://coveralls.io/github/alessiofrittoli/next-api
[socket-badge]: https://socket.dev/api/badge/npm/package/@alessiofrittoli/next-api
[socket-url]: https://socket.dev/npm/package/@alessiofrittoli/next-api/overview
[downloads-badge]: https://img.shields.io/npm/dm/%40alessiofrittoli%2Fnext-api.svg
[deps-badge]: https://img.shields.io/librariesio/release/npm/%40alessiofrittoli%2Fnext-api
[deps-url]: https://libraries.io/npm/%40alessiofrittoli%2Fnext-api
[sponsor-badge]: https://img.shields.io/static/v1?label=Fund%20this%20package&message=%E2%9D%A4&logo=GitHub&color=%23DB61A2
[sponsor-url]: https://github.com/sponsors/alessiofrittoli
## Next.js API utility library
### Table of Contents
- [Getting started](#getting-started)
- [API Reference](#api-reference)
- [Development](#development)
- [Install depenendencies](#install-depenendencies)
- [Build the source code](#build-the-source-code)
- [ESLint](#eslint)
- [Jest](#jest)
- [Contributing](#contributing)
- [Security](#security)
- [Credits](#made-with-)
---
### Getting started
Run the following command to start using `next-api` in your projects:
```bash
npm i @alessiofrittoli/next-api
```
or using `pnpm`
```bash
pnpm i @alessiofrittoli/next-api
```
---
### API Reference
-- Docs coming soon --
---
### Development
#### Install depenendencies
```bash
npm install
```
or using `pnpm`
```bash
pnpm i
```
#### Build the source code
Run the following command to test and build code for distribution.
```bash
pnpm build
```
#### [ESLint](https://www.npmjs.com/package/eslint)
warnings / errors check.
```bash
pnpm lint
```
#### [Jest](https://npmjs.com/package/jest)
Run all the defined test suites by running the following:
```bash
# Run tests and watch file changes.
pnpm test:watch
# Run tests in a CI environment.
pnpm test:ci
```
- See [`package.json`](./package.json) file scripts for more info.
Run tests with coverage.
An HTTP server is then started to serve coverage files from `./coverage` folder.
⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.
```bash
test:coverage:serve
```
---
### Contributing
Contributions are truly welcome!
Please refer to the [Contributing Doc](./CONTRIBUTING.md) for more information on how to start contributing to this project.
Help keep this project up to date with [GitHub Sponsor][sponsor-url].
[![GitHub Sponsor][sponsor-badge]][sponsor-url]
---
### Security
If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `[email protected]` to disclose any security vulnerabilities.
### Made with ☕
Alessio Frittoli
https://alessiofrittoli.it |
[email protected]