diff --git a/README.md b/README.md index 6ddc9b8f..f00a1362 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,37 @@ -![OrbitKit](https://github.com/ixahmedxi/orbitkit/blob/main/apps/marketing/public/blog-placeholder.jpg?raw=true) - -## Note - -> [!IMPORTANT] -> OrbitKit is built on top of a very opinionated tech stack, which might not work for every use case/business idea. I offer monorepo architecture consulting or even building something completely custom for you, if you are interested be sure to [DM me on X/Twitter](https://twitter.com/ixahmedxii). +
+ Cover image +
## Features -- Next.js Web Application -- Astro Marketing Website -- File uploads with Uploadthing -- ESM Only -- TailwindCSS -- Lucia auth with github and google oauth -- Typesafe Next.js routes -- Drizzle ORM -- Neon DB -- Rate limiting with [Unkey](https://unkey.dev) -- Dedicated ShadCN UI primitives package -- Storybook -- Radix UI Colors for auto light/dark mode -- Next themes -- Shared tooling configuration -- Spell checking -- Markdown linting -- Turborepo task caching -- ESLint for linting -- Prettier formatting -- Commitlint with pnpm scopes -- Lint staged -- Husky -- TS Reset for the applications -- Packages built using tsup -- Changesets for versioning +- [**Monorepo**](https://monorepo.tools/): OrbitKit is a monorepo, giving you the ability to scale your project with ease. +- [**TypeScript**](https://www.typescriptlang.org/): type-safety is a core principle of OrbitKit. +- [**Astrojs**](https://astro.build): for a clean slate to build your marketing website on top. +- [**Next.js**](https://nextjs.org): Web application is included, giving you a solid foundation for your product. +- [**Turborepo**](https://turbo.build/repo): caching builds so you never have to run the same command twice. +- [**Drizzle ORM**](https://orm.drizzle.team): providing a fully type-safe way to interact with your database. +- [**Neon DB**](https://neon.tech): serverless database, with autoscaling, branching, and bottomless storage. +- [**Uploadthing**](https://uploadthing.com/): for an easy, type-safe way of handling file uploads. +- [**Unkey**](https://unkey.dev): for a fast way of rate-limiting the web app. +- [**Lucia auth**](https://lucia-auth.com): for authentication, giving you full flexibility and control over your user system. +- [**Tailwind CSS**](https://tailwindcss.com): for styling, with [**Radix UI Colors**](https://www.radix-ui.com/colors) for automatic light/dark mode handling. +- [**Shadcn UI**](https://ui.shadcn.com): full implementation in a dedicated package. +- [**Storybook**](https://storybook.js.org): to develop, test and visualize your components in isolation. +- [**Github Actions**](https://github.com/features/actions): for CI/CD, with automatic DB branching & code checks. +- [**next-themes**](https://github.com/pacocoursey/next-themes): for easy light/dark mode handling in the web app. +- [**Changesets**](https://github.com/changesets/changesets): for managing versioning and changelogs. +- [**tsup**](https://github.com/egoist/tsup): for fast, easy to configure bundling of packages. +- [**ts-reset**](https://github.com/total-typescript/ts-reset): for the apps, improving the types for common JavaScript APIs. +- [**ESLint**](https://eslint.org/), [**Prettier**](https://prettier.io), [**Markdownlint**](https://github.com/DavidAnson/markdownlint), [**Cspell**](https://cspell.org), [**Husky**](https://github.com/typicode/husky), [**Lint-staged**](https://github.com/lint-staged/lint-staged) and [**Commitlint**](https://github.com/conventional-changelog/commitlint) for code quality. +- **ESM Only**: because CJS should be left in the past. And much more! +## Note + +> [!IMPORTANT] +> OrbitKit is built on top of a very opinionated tech stack, which might not work for every use case/business idea. I offer monorepo architecture consulting or even building something completely custom for you, if you are interested be sure to [DM me on X/Twitter](https://twitter.com/ixahmedxii). + ## Todos OrbitKit is not in final form yet, there are many things in the plans for it but it is in a usable primitive state. Checkout the [Roadmap](https://github.com/users/ixahmedxi/projects/6) for more info. diff --git a/apps/marketing/public/blog-placeholder.jpg b/apps/marketing/public/blog-placeholder.jpg index eeb01d8a..b47ff4bf 100644 Binary files a/apps/marketing/public/blog-placeholder.jpg and b/apps/marketing/public/blog-placeholder.jpg differ