v1 Setup

[jackyzha0]

• Scaffold new project using Typescript + Fastify + Ava + Standardjs + Swagger + Prometheus
• Setup CI to run on push/PR (lint + test)

Closes hyphacoop/distributed-press-organizing#57

[catdevnull]

Do ping me for reviewing :)

[RangerMauve]

Great progress! I think the general structure is exactly what we need. 👍

Just left a few comments on some details that could be changed.

[RangerMauve]

Jacky is figuring out the typescript issues with the promethius logger, and we'll create a new issue for it and merge what we have for the project structure so far so that Fauno and others can run the server stubs to start

[fauno]

Just to note the build breaks if you're using pnpm, I think it's because you need to add this dependency explicitly

> pnpm run build

> distributed-press-api@0.1.0 build /Sutty/api.distributed.press/v1
> npm run clean && tsc


> distributed-press-api@0.1.0 clean
> rm -rf build

api/admin.ts:1:24 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

1 import { Static } from '@sinclair/typebox'
                         ~~~~~~~~~~~~~~~~~~~

api/publisher.ts:1:30 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

1 import { Type, Static } from '@sinclair/typebox'
                               ~~~~~~~~~~~~~~~~~~~

api/schemas.ts:1:22 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

1 import { Type } from '@sinclair/typebox'
                       ~~~~~~~~~~~~~~~~~~~

api/sites.ts:2:30 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

2 import { Type, Static } from '@sinclair/typebox'
                               ~~~~~~~~~~~~~~~~~~~

config/admin.ts:2:24 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

2 import { Static } from '@sinclair/typebox'
                         ~~~~~~~~~~~~~~~~~~~

config/publisher.ts:2:24 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

2 import { Static } from '@sinclair/typebox'
                         ~~~~~~~~~~~~~~~~~~~

config/sites.ts:2:24 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

2 import { Static } from '@sinclair/typebox'
                         ~~~~~~~~~~~~~~~~~~~

node_modules/.pnpm/@fastify+type-provider-typebox@2.4.0_fastify@4.10.2/node_modules/@fastify/type-provider-typebox/dist/index.d.ts:2:33 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

2 import { Static, TSchema } from '@sinclair/typebox';
                                  ~~~~~~~~~~~~~~~~~~~

protocols/interfaces.ts:1:24 - error TS2307: Cannot find module '@sinclair/typebox' or its corresponding type declarations.

1 import { Static } from '@sinclair/typebox'
                         ~~~~~~~~~~~~~~~~~~~


Found 9 errors in 9 files.

Errors  Files
     1  api/admin.ts:1
     1  api/publisher.ts:1
     1  api/schemas.ts:1
     1  api/sites.ts:2
     1  config/admin.ts:2
     1  config/publisher.ts:2
     1  config/sites.ts:2
     1  node_modules/.pnpm/@fastify+type-provider-typebox@2.4.0_fastify@4.10.2/node_modules/@fastify/type-provider-typebox/dist/index.d.ts:2
     1  protocols/interfaces.ts:1
 ELIFECYCLE  Command failed with exit code 2.

[fauno]

pnpm add @sinclair/typebox fixed it

[fauno]

openapi-generator-cli said:

        -attribute paths.'/v1/publisher/{id}'. Declared path parameter id needs to be defined as a path parameter in path or operation level
        -attribute paths.'/v1/admin/{id}'. Declared path parameter id needs to be defined as a path parameter in path or operation level

[fauno]

openapi-generator-cli said:

        -attribute paths.'/v1/publisher/{id}'. Declared path parameter id needs to be defined as a path parameter in path or operation level
        -attribute paths.'/v1/admin/{id}'. Declared path parameter id needs to be defined as a path parameter in path or operation level

doesn't happen with swagger-codegen-cli

[RangerMauve]

Feel free to merge this 👍