web-app-template
A minimal web service template π "npx create-app-foundation@latest" !
File Explorer
Download Latest Version (.zip)- action.yml
- action.yml
- ci.yml
- claude-code-review.yml
- claude.yml
- internal.yml
- site.yml
- update-internal-e2e.yml
- git.mjs
- index.mjs
- package.json
- pnpm-lock.yaml
- README.md
- app-(public)-page.tsx
- app-layout.tsx
- docker.mjs
- e2e.mjs
- index.mjs
- otel.mjs
- sample-code.mjs
- stripe.mjs
- common-processing.mjs
- db.mjs
- format.mjs
- init.mjs
- package-json.mjs
- utils.mjs
- config.mts
- code-quality-automation.md
- e2e-testing.md
- next-auth.md
- nextjs.md
- observability.md
- prisma.md
- stripe.md
- unit-testing.md
- challenges-solved.md
- dotenv.md
- getting-started.md
- routing.md
- tasks.md
- what-is-web-app-template.md
- biome.png
- copilot.png
- docker.png
- editorconfig.png
- github-actions.png
- knip.png
- lefthook.png
- next-auth.png
- nextjs.png
- otel.png
- playwright.png
- pnpm.svg
- postgresql.png
- prettier.png
- prisma.png
- react-hook-form.png
- renovate.png
- stripe.png
- tailwind.png
- testcontainers.png
- testing-library.png
- typescript.png
- vitest.png
- vscode.png
- zod.svg
- stripe-cancel-flow.png
- stripe-checkout-flow.png
- stripe-webhook-flow.png
- query.png
- root-metric.png
- icon.png
- favicon.ico
- index.md
- package-lock.json
- package.json
- all-opt-out.test.mjs
- Basetest.mjs
- common.test.mjs
- common.test.mjs.snapshot
- makefile
- no-docker.test.mjs
- no-docker.test.mjs.snapshot
- no-e2e.test.mjs
- no-e2e.test.mjs.snapshot
- no-otel.test.mjs
- no-otel.test.mjs.snapshot
- no-sample-code.test.mjs
- no-sample-code.test.mjs.snapshot
- no-stripe.test.mjs
- no-stripe.test.mjs.snapshot
- .gitignore
- README.md
- extensions.json
- mcp.json
- settings.json
- itemPage.test.ts
- mePage.test.ts
- notFoundPage.test.ts
- signInPage.test.ts
- topPage.test.ts
- app.ts
- getRandomPort.ts
- prisma.ts
- users.ts
- waitForHealth.ts
- auth.test.ts
- item.test.ts
- user.test.ts
- Base.ts
- ItemPage.ts
- MePage.ts
- NotFoundPage.ts
- SignInPage.ts
- TopPage.ts
- auth.ts
- dummyUsers.ts
- fixtures.ts
- item.prisma
- schema.prisma
- user.prisma
- .gitkeep
- UpdateMyInfo.tsx
- PaymentButton.tsx
- page.tsx
- page.tsx
- layout.tsx
- ItemManager.tsx
- page.tsx
- page.tsx
- layout.tsx
- page.tsx
- items.test.ts
- items.ts
- payment.test.ts
- payment.ts
- users.test.ts
- users.ts
- nextAuth.ts
- nextAuthConfig.ts
- prisma.ts
- stripe.ts
- AuthButtons.tsx
- Button.tsx
- Container.tsx
- ErrorPageTemplate.tsx
- Footer.tsx
- FormBox.tsx
- Header.tsx
- Input.tsx
- useFormId.test.ts
- useFormId.ts
- useOnlineStatus.test.ts
- useOnlineStatus.ts
- items.test.ts
- items.ts
- users.test.ts
- users.ts
- result.ts
- auth.test.ts
- auth.ts
- date.test.ts
- date.ts
- db.test.ts
- db.ts
- payment.test.ts
- payment.ts
- zod.test.ts
- zod.ts
- route.ts
- route.test.ts
- route.ts
- route.test.ts
- route.ts
- error.tsx
- favicon.ico
- global-error.tsx
- globals.css
- globals.d.ts
- layout.tsx
- not-found.tsx
- opengraph-image.tsx
- robots.txt
- node.ts
- instrumentation.ts
- proxy.test.ts
- proxy.ts
- db.setup.ts
- vitest.helper.ts
- vitest.setup.ts
- .dockerignore
- .editorconfig
- .env.sample
- .env.test
- .gitignore
- .node-version
- .npmrc
- biome.json
- compose.yml
- Dockerfile
- env.ts
- knip.config.ts
- lefthook.yml
- LICENSE
- next.config.ts
- otel-collector-config.yml
- package.json
- playwright.config.ts
- pnpm-lock.yaml
- pnpm-workspace.yaml
- postcss.config.mjs
- prisma.config.ts
- README.md
- renovate.json
- tsconfig.json
- vitest.config.ts
# Installation Guide
1. Get the code
git clone https://github.com/hiroppy/web-app-template
Downloads the entire project code from GitHub to your computer.
cd web-app-template
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
$ npm run setup
Type this command into your terminal and run it.
$ pnpm i
Type this command into your terminal and run it.
$ pnpm dev
Starts the development/run server.
$ pnpm dev:stripe
Starts the development/run server.
$ pnpm db:up
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)