Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trpc-openapi is not generating the correct types for enums and unions of literal... #173

Open
3 of 7 tasks
github-actions bot opened this issue Jun 10, 2023 · 0 comments
Open
3 of 7 tasks
Labels

Comments

@github-actions
Copy link

https://api.github.com/BKK-WeSpace/tree-population/blob/e41a837e40ad87e41bcb6aea273205a2b298ff33/README.md#L56

This is a new wespace documentation and is under construction.

# Public Endpoints

The full Swagger docs for all public endpoints can be viewed in /api/api-docs

# Getting Started

npm install

npm run dev


# Contributing

This project uses the standard T3 folder structure. We might migrate to a monorepo structure with separate packages later. But for the time being, we see no need to do so. Those already familiar with T3 should be able to make contributions right away.

## Schemas

We use `Zod` for all request/respons schemas to make validations easier.

Instead of 

```ts
    interface SomeType {
        name: string;
    }
    // or
    type SomeType = {name: string}

We do

    const SomeSchema = z.object({
        name: z.string()
    });

    // and where needed

    function someFunc(stuff: z.infer<typeof SomeSchema>) {
        //...
    }

About

Things yet to be done

  • Bring in maplibre
  • Integrate with Vallaris (requires a good backend architecture to make it not Vallaris-dependent).
  • Integrate https://github.com/jlalmes/trpc-openapi to integrate open-api specs (and also document it here)
  • TODO trpc-openapi is not generating the correct types for enums and unions of literals.
  • TODO Code of conduct
  • TODO More stuff to this todo list
  • TODO CI/CD -> Deployment, linting, testing, etc.
@github-actions github-actions bot added the todo label Jun 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

0 participants