Planning Poker

A simple project for all of your story pointing needs! This is a template which you may fork, customize and stand up your own server with.

Using this example

• Clone the repository.
• Install packages, using your package manager of choice, npm, pnpm, or yarn.
• Run npm run dev, pnpm dev, yarn dev.

Env variable

This package does use .env | .env.local files in order to inject useable values. You will have to manually add this file to get it up and running.

.env.local

VITE_API_URL="0.0.0.0"
VITE_API_PORT="4040"
NODE_VERSION=18
# The following are not required for local dev, but REQUIRED for production
VITE_FULL_API_URL="https://your_api.com/api"
# For allowing CORS in production.
VITE_WEB_URL='https://your_web_url.com'

In a production environment these values will have to be changed to your own server details.

What's inside?

A simple Turborepo project with TypeScript as a focus. There are two primary locations within the project, apps which are runnable applications, and packages which are shared configurations.

apps

• api: a fastify server
• web: a SvelteKit application using SkeletonUi

packages

• eslint-config-custom: a custom sharable configuration for eslint
• planning-poker-types: shared zod and typescript types
• tsconfig: shared tsconfig

Each package/app should be 100% TypeScript.

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd planning-poker-turbo-sveltekit-fastify
npm run build

Develop

To develop all apps and packages, run the following command:

cd planning-poker-turbo-sveltekit-fastify
npm run dev

Useful Links

Learn more about the power of Turborepo:

• Tasks
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage