Skip to content

GQL-Project/gql_client

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Getting Started

Install dependencies

npm install next react react-dom identity-obj-proxy prismjs react-simple-code-editor

npm install --save-dev jest @types/jest @types/prismjs @babel/preset-typescript ts-jest babel-plugin-transform-es2015-modules-commonjs @babel/plugin-transform-runtime @testing-library/react @testing-library/jest-dom

Run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Building Proto Files

Run the following command from the root directory, after npm install:

protoc --plugin=protoc-gen-ts_proto=.\node_modules\.bin\protoc-gen-ts_proto.cmd --ts_proto_opt=esModuleInterop=true --ts_proto_opt=outputServices=grpc-js --ts_proto_out=. .\pages\proto\connection.proto

This will produce (almost) valid types. However, we need to make a few changes to the generated files:

  • NOTE: This is only necessary when modifying the proto files. The generated files are already included in the repo.
  • Navigate to the DatabaseConnectionClient interface in connection.ts, and change the names of all the methods to have an uppercase first letter.
  • This is because the generated methods are all lowercase, but the grpc-js library expects them to be uppercase.
  • We don't need to change much else, as these are just used as type references.

About

Database and Version Control Web Client

Resources

Stars

Watchers

Forks

Contributors