Skip to content

VidunderGunder/starter

Repository files navigation

Starter

A fullstack cross-platform template using:

Automatic CRUD API, GraphQL API and types generated from Prisma.

It's like a very opinionated variant of RedwoodJS.

🚀 Quickstart (Web)

Install Node.js (between 16.10.0 and 17.0.0)

Install Yarn (v1.22.19 or higher)

Install dependencies and start development:

yarn
yarn dev

📱 iOS and Android

Setup Capacitor for iOS or Android (or both) Build the mobile apps:

yarn mobile-build

Open the iOS app in Xcode:

npx ionic cap run ios -l --external

Open the Android app in Android Studio:

npx ionic cap run android -l --external

Docs

Before the Storybook is ready for deployment, you can view the docs locally by starting development and visiting http://localhost:6006/ (should happen automagically with the script).

Why aren't all the docs available in the README?

Some of the docs is very interactive and running everything live locally.

TODOs

  • Automatically adjust URLs to work in development both locally and in cloud environments (e.g. GitHub Codespaces and CodeSandbox Projects)
  • Support styled-components' css-prop when using SWC with StoryBook
  • Address yarn dev warnings
  • Improve MDX integration
    • Get css-prop to work
    • Better type checking
    • Better IntelliSense
    • Markdown tooling feature parity for VSCode
  • More intuitive way of using TypeGraphQL-classes in the client
    • For example: SomeExampleModel.prototype will return undefined, even though TypeScript promises a result
    • A shim-fix has been implemented (see prisma/browser-shim.ts and webpack-configs), but it only stops the build from crashing. The user can still try to get data from the server, but the types are wrong.