https://github.com/olegkorol/instant-turbo
(WIP) A simple monorepo with Next.js and InstantDB (powered by Turborepo).
https://github.com/olegkorol/instant-turbo
Last synced: 2 months ago
JSON representation
(WIP) A simple monorepo with Next.js and InstantDB (powered by Turborepo).
- Host: GitHub
- URL: https://github.com/olegkorol/instant-turbo
- Owner: olegkorol
- Created: 2025-02-12T06:12:29.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T06:16:34.000Z (3 months ago)
- Last Synced: 2025-02-12T07:28:28.280Z (3 months ago)
- Language: TypeScript
- Size: 229 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# instant-turbo
A starter Turborepo with Next.js, TailwindCSS and instantDB.
> Note: This is a work in progress.
## Roadmap
- [x] Add instantDB to the monorepo (simplest way possible)
- [ ] Add simple todo-list example
- [x] Expose an admin instantDB instance for server-side actions / api routes
- [ ] Ensure type-safety across frontend and backend
- [x] Add TailwindCSS to the Next.js apps
- [ ] Create turbo generators for new apps and packages
- [ ] etc.
## Using this example
Run the following command:
```sh
pnpm install && pnpm dev
```
## What's inside?
This Turborepo includes the following packages/apps:
### Apps and Packages
- `web`: another [Next.js](https://nextjs.org/) app
- `@repo/idb`: instantDB browser and server clients
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
- `@repo/tailwind-config`: TailwindCSS configuration
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### Utilities
This Turborepo has some additional tools already setup for you:
- [TypeScript](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
### Build
To build all apps and packages, run the following command:
```sh
pnpm build
```
### Develop
To develop all apps and packages, run the following command:
```sh
pnpm dev
```
### Remote Caching
> [!TIP]
> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:
```sh
npx turbo login
```
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
```sh
npx turbo link
```
## Useful Links
Learn more about the power of Turborepo:
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)