client

Client is using TypeScript, NextJS and GraphQL.

---

Client website: https://stegoer.netlify.app/

Development documentation: https://github.com/stegoer/client/blob/master/README.md

Reference documentation: https://stegoer.github.io/client

Source code: https://github.com/stegoer/client

---

Installation

Install instructions

1. Install Node.js https://nodejs.org/en/download/
2. Clone this repository

git clone git@github.com:stegoer/client.git

4. Install dependencies

npm install

Create the .env.local file

Create a .env.local file and copy the contents of .env.local.example file into the .env.local file

cp .env.local.example .env.local

Development

Dev server

npm run dev

package.json scripts

npm run-script

GraphQL

GraphQL Code Generator is used to generate type definitions and hooks for queries and mutations. See client/src/graphql/codegen.yml for configuration options.

Codegen

npm run graphql:gen

To add a new query or mutation head to src/graphql/user or src/graphql/image and add a new file.

To add a new fragment head to the src/graphql/fragments folder.

Reference documentation

npm run docs:build

TypeDoc is used to generate documentation which is then published via the Docs GitHub Action on GitHub Pages.

See typedoc.json for configuration.

Contributing

pre-commit install

License

Developed under the MIT license.