renhyl / bs-sw Goto Github PK

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

This is simple demo app demonstrating use of NextJS v14 with TailwindCSS, Apollo Client and GraphQL (including graphql-codegen). App is using public Star Wars API: https://studio.apollographql.com/public/star-wars-swapi/variant/current/explorer

https://nextjs.org/docs was chosen as it is is one of the leading ReactJS frameworks which allows for Server Side rendering and Client Side Rendering, it is widly supported and has big community. https://tailwindcss.com/docs/installation was chosen as it is one of the best utility first CSS libraries, it allows for rapid development. https://ui.shadcn.com/ is React/TailWindCSS component library which offers many lightweight components to kick start any react project. https://www.apollographql.com/docs/ is one of the most popular GraphQL clients, with large community support (other options to consider https://www.prisma.io/orm and https://houdinigraphql.com/)

Project uses https://www.typescriptlang.org/docs/ to ensure type safety, in addition graphql code-gen ensures GraphQL graphs/queries/mutations are type safe when used across the app.

Depending on the project/app and requirements there are number of ways SSR/CSR balance can be set up, especially in NextJS when consuming the APIs. There is potential for some case scenarios where API resources could be fetched only in Client and Suspended until resolved while others could be done only on SSR. While this demo domstrates use case of both to strike the balance of avoiding loaders and layout shifts/blinks and performance by avoiding fetching all data from endpoint all at once

copy .env.example file, rename to .env or .env.local

run cmd: npm i to install npm dependencies

run cmd: npm run generate-gql to generate graphql typescript types

run cmd: npm run dev to start nextjs in dev mode

Playwright test are setup and can be run by VSCode extension or terminal by executing: npm run test

run cmd: npm run build

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

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

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

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

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

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

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

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.