Skip to content

Commit

Permalink
Add initial implementation
Browse files Browse the repository at this point in the history
This is the result of the initial development/MVP
for Next REST Framework. The framework already
includes extensive features like support for OpenAPI
spec auto generations, object-schema support for Zod
and Yup and lots of user config options but the API
is not considered to be fully stable yet.

This includes the monorepo contents with the actual
library code, a development application, CI configs
etc. that are needed for further development.
  • Loading branch information
blomqma committed Dec 6, 2022
1 parent 7b6070e commit d02224b
Show file tree
Hide file tree
Showing 53 changed files with 8,563 additions and 0 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
17 changes: 17 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
const path = require('path');

module.exports = {
root: true,
extends: ['standard-with-typescript', 'prettier'],
parserOptions: {
project: [
path.resolve(__dirname, './packages/*/tsconfig.json'),
path.resolve(__dirname, './apps/*/tsconfig.json')
]
},
rules: {
'@typescript-eslint/strict-boolean-expressions': 'off',
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/restrict-template-expressions': 'off'
}
};
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "CI"

on:
push:
branches: [main]
pull_request:

jobs:
build:
name: "Run CI pipeline"
runs-on: ubuntu-latest
strategy:
matrix:
node: [14, 16, 18]
steps:
- uses: actions/checkout@v3
- uses: pnpm/[email protected]
with:
version: 7.5.1
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node }}
cache: "pnpm"
- run: pnpm i
- run: pnpm build
- run: pnpm type-check
- run: pnpm lint
- run: pnpm test

# - name: Coverage
# uses: codecov/codecov-action@v3
# with:
# fail_ci_if_error: true
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
2 changes: 2 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
auto-install-peers=true
ignore-workspace-root-check=true
3 changes: 3 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
dist
.next
coverage
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
All notable changes to this project will be documented in this file.
We follow the [Semantic Versioning 2.0.0](http://semver.org/) format.

## 1.0.0 - 2022-12-03

### Added

- Added initial version of Next REST Framework.
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla coc].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla coc]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
63 changes: 63 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Development

Clone the repository:

```
git clone [email protected]:blomqma/next-rest-framework.git
```

Install dependencies:

```
pnpm i
```

Build the `next-rest-framework` package:

```
pnpm run build
```

Run the development Next.js project:

```
pnpm run dev
```

To test your changes in the `next-rest-framework` package against the dev project, simply rebuild the package with `pnpm run build` and the changes will be synced automatically.

Run unit tests:

```
pnpm run test
```

Run unit tests in watch mode:

```
pnpm run test:watch
```

Run formatting:

```
pnpm run format
```

Run linting:

```
pnpm run lint
```

# Documentation

All documentation is in [README.md](https://github.com/blomqma/next-rest-framework/blob/main/README.md), please update that when needed.

# Pull requests

All pull requests are welcome and done against the `main` branch, please write tests for all changes, write documentation when needed and use descriptive commit messages. No need to update the changelog.

# License

By contributing, you agree to license your contribution under the [LICENSE](https://github.com/blomqma/next-rest-framework/blob/main/LICENCE).
1 change: 1 addition & 0 deletions LICENCE
1 change: 1 addition & 0 deletions README.md
5 changes: 5 additions & 0 deletions apps/dev/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
rules: {
'@typescript-eslint/triple-slash-reference': 'off'
}
}
36 changes: 36 additions & 0 deletions apps/dev/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
5 changes: 5 additions & 0 deletions apps/dev/next-rest-framework/client.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { NextRestFramework } from 'next-rest-framework';

export const { defineCatchAllHandler, defineEndpoints } = NextRestFramework({
middleware: () => ({ foo: 'foo', bar: 'bar', baz: 'baz' })
});
7 changes: 7 additions & 0 deletions apps/dev/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/** @type {import('next').NextConfig} */
const nextConfig = {
reactStrictMode: true,
swcMinify: true,
};

module.exports = nextConfig;
21 changes: 21 additions & 0 deletions apps/dev/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "dev",
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint",
"type-check": "tsc --noEmit"
},
"dependencies": {
"next-rest-framework": "workspace:*"
},
"devDependencies": {
"@types/node": "18.11.9",
"@types/react": "18.0.25",
"@types/react-dom": "18.0.8",
"react": "18.2.0",
"react-dom": "18.2.0"
}
}
18 changes: 18 additions & 0 deletions apps/dev/pages/api/[[...next-rest-framework]].ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { defineCatchAllHandler } from 'next-rest-framework/client';
import * as z from 'zod';

export default defineCatchAllHandler({
GET: {
responses: [
{
status: 200,
contentType: 'text/plain',
schema: z.string()
}
],
handler: ({ res }) => {
res.setHeader('Content-Type', 'text/plain');
res.status(200).send('Hello, world!');
}
}
});
Loading

0 comments on commit d02224b

Please sign in to comment.