Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vidundergunder/starter
A fullstack cross-platform template
https://github.com/vidundergunder/starter
apollo capacitor crud css-prop graph ionic nextjs prisma react storybook styled-components
Last synced: about 2 months ago
JSON representation
A fullstack cross-platform template
- Host: GitHub
- URL: https://github.com/vidundergunder/starter
- Owner: VidunderGunder
- Created: 2022-10-16T17:29:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-23T12:39:38.000Z (over 2 years ago)
- Last Synced: 2023-03-10T15:22:01.069Z (almost 2 years ago)
- Topics: apollo, capacitor, crud, css-prop, graph, ionic, nextjs, prisma, react, storybook, styled-components
- Language: TypeScript
- Homepage: https://raccoon-starter.vercel.app
- Size: 815 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Starter
A fullstack cross-platform template using:
- [Next.js](https://nextjs.org/)
- [Prisma](https://www.prisma.io/)
- [GraphQL (Apollo)](https://www.apollographql.com/)
- [Capacitor](https://capacitorjs.com/)
- [Ionic](https://ionicframework.com/) (based on )
- [Storybook](https://storybook.js.org/)
Automatic CRUD API, GraphQL API and types generated from Prisma.
It's like a very opinionated variant of [RedwoodJS](https://redwoodjs.com/).
## 🚀 Quickstart (Web)
Install [Node.js](https://nodejs.org/en/download/) (between 16.10.0 and 17.0.0)
Install [Yarn](https://yarnpkg.com/en/docs/install) (v1.22.19 or higher)
Install dependencies and start development:
```bash
yarn
yarn dev
```
## 📱 iOS and Android
Setup [Capacitor](https://capacitorjs.com/docs/getting-started) for iOS or Android (or both)
Build the mobile apps:
```bash
yarn mobile-build
```
Open the iOS app in Xcode:
```bash
npx ionic cap run ios -l --external
```
Open the Android app in Android Studio:
```bash
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](https://styled-components.com/)' `css`-prop when using [SWC](https://swc.rs/) with [StoryBook](https://storybook.js.org/)
- The `css`-prop is currently the only thing holding us back from using [SWC with StoryBook](https://nextjs.org/docs/advanced-features/compiler#styled-components)
- StoryBook supports the `css`-prop now, but uses Babel instead of SWC:
```js
module.exports = {
babel: {
plugins: [["babel-plugin-styled-components", styledConfig]],
}
};
```
- Preferably make [Next.js' styled-components support](https://nextjs.org/docs/advanced-features/compiler#styled-components) work with [SWC and StoryBook](https://nextjs.org/docs/advanced-features/compiler#styled-components)
- We're using a [Next-addon for StoryBook](https://storybook.js.org/addons/storybook-addon-next/), but it's seemingly not supporting SWC
- Why even use SWC?
- It's [many times faster than Babel](https://swc.rs/)
- [Vercel's reasoning for using SWC for Next.js](https://nextjs.org/docs/advanced-features/compiler#why-swc)
- Same behavior between StoryBook and Next.js
- [ ] Address `yarn dev` warnings
- [ ] Improve [MDX](https://mdxjs.com/) 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.