Skip to content

Latest commit

 

History

History
66 lines (53 loc) · 4.46 KB

README.md

File metadata and controls

66 lines (53 loc) · 4.46 KB
Raw
Cover image

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.

Features

  • Monorepo: OrbitKit is a monorepo, giving you the ability to scale your project with ease.
  • TypeScript: type-safety is a core principle of OrbitKit.
  • Astrojs: for a clean slate to build your marketing website on top.
  • Next.js: Web application is included, giving you a solid foundation for your product.
  • Posthog: for analytics and event tracking.
  • Sentry: for error tracking and monitoring.
  • tRPC for a fully type-safe api.
  • Mintlify: for a clean, fast, and easy to use platform to document your project.
  • Turborepo: caching builds so you never have to run the same command twice.
  • Drizzle ORM: providing a fully type-safe way to interact with your database.
  • Neon DB: serverless database, with autoscaling, branching, and bottomless storage.
  • Uploadthing: for an easy, type-safe way of handling file uploads.
  • Unkey: for a fast way of rate-limiting the web app.
  • Playwright: for end-to-end testing of the applications.
  • Lucia auth: for authentication, giving you full flexibility and control over your user system.
  • Tailwind CSS: for styling, with Radix UI Colors for automatic light/dark mode handling.
  • Shadcn UI: full implementation in a dedicated package.
  • Storybook: to develop, test and visualize your components in isolation.
  • Github Actions: for CI/CD, with automatic DB branching & code checks.
  • next-themes: for easy light/dark mode handling in the web app.
  • Changesets: for managing versioning and changelogs.
  • vite: for bundling & storybook.
  • ts-reset: for the apps, improving the types for common JavaScript APIs.
  • ESLint, Prettier, Markdownlint, Cspell, Husky, Lint-staged and Commitlint for code quality.
  • ESM Only: because CJS should be left in the past.

And much more!

Documentation

To get started with OrbitKit, head over to the documentation website where you can find installation instructions and how to work with the codebase.

License

MIT License

Copyright (c) 2024 Ahmed Elsakaan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.