Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 1.94 KB

README.md

File metadata and controls

76 lines (48 loc) · 1.94 KB

Star Wars Planet Explorer (SvelteKit)

Purpose & Design choices

Purpose of this project is to show skills with SvelteKit and TypeScript.

Globa State Management

API Notes

There are at least two choices:

  • ✅ swapi.info (in use)
    • ❌ Missing pagination & search
    • ✅ JSON Schema
  • ❌ swapi.dev
    • ✅ Have pagination & search
    • ❌ JSON Schema not working, see #37, ⎇66

Schema for SW API

You can run pnpm gen:swapi, see more in src/lib/swapi-schema/README

Developer guidelines

sv

Everything you need to build a Svelte project, powered by sv.

Creating a project

If you're seeing this, you've probably already done this step. Congrats!

# create a new project
npx sv create my-app

To recreate this project with the same configuration:

# recreate this project
pnpm dlx sv create --template minimal --types ts --add prettier eslint vitest="usages:unit,component" playwright tailwindcss="plugins:forms,typography" sveltekit-adapter="adapter:cloudflare+cfTarget:workers" devtools-json --install pnpm swapi-svelte

Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.