Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add technology stack details to README #133

Merged
merged 1 commit into from
May 12, 2024

Conversation

nexmoe
Copy link
Owner

@nexmoe nexmoe commented May 12, 2024

This commit adds a detailed section on the technology stack used in the project, including the following key components:

  • Nuxt 3: A high-performance Vue.js framework for building server-side rendered (SSR) and statically generated (SSG) applications.
  • Prisma: A type-safe ORM (Object-Relational Mapping) for Node.js and TypeScript, used for database interactions.
  • TRPC (Tanner's Request/Response Protocol): A type-safe request-response protocol for building APIs.
  • Pinia: A state management library for Vue, used as an alternative to Vuex.
  • TypeScript: A superset of JavaScript that provides static typing, improving code quality.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • VueUse: A collection of useful Vue Composition API utilities.
  • ESLint: A code quality linter to ensure consistent code style and best practices.
  • Husky: A tool for running scripts before Git commits, used for code quality checks.
  • AWS SDK v3: A library for interacting with Amazon Web Services, particularly the S3 storage service.
  • Other supporting libraries and technologies, such as Sharp, Clsx, Zod, Dayjs, and UUID.

The changes are intended to provide a comprehensive overview of the project's technology stack, which is focused on performance optimization, maintainability, and developer productivity, combining server-side rendering, static site generation, database operations, state management, and test automation.

This commit adds a detailed section on the technology stack used in the project, including the following key components:

- Nuxt 3: A high-performance Vue.js framework for building server-side rendered (SSR) and statically generated (SSG) applications.
- Prisma: A type-safe ORM (Object-Relational Mapping) for Node.js and TypeScript, used for database interactions.
- TRPC (Tanner's Request/Response Protocol): A type-safe request-response protocol for building APIs.
- Pinia: A state management library for Vue, used as an alternative to Vuex.
- TypeScript: A superset of JavaScript that provides static typing, improving code quality.
- Tailwind CSS: A utility-first CSS framework for rapid UI development.
- VueUse: A collection of useful Vue Composition API utilities.
- ESLint: A code quality linter to ensure consistent code style and best practices.
- Husky: A tool for running scripts before Git commits, used for code quality checks.
- AWS SDK v3: A library for interacting with Amazon Web Services, particularly the S3 storage service.
- Other supporting libraries and technologies, such as Sharp, Clsx, Zod, Dayjs, and UUID.

The changes are intended to provide a comprehensive overview of the project's technology stack, which is focused on performance optimization, maintainability, and developer productivity, combining server-side rendering, static site generation, database operations, state management, and test automation.
Copy link

vercel bot commented May 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
roam-space 🔄 Building (Inspect) Visit Preview 💬 Add feedback May 12, 2024 10:45am

@nexmoe nexmoe merged commit 48750d3 into main May 12, 2024
2 of 3 checks passed
@nexmoe nexmoe deleted the update-readme-with-tech-stack branch May 12, 2024 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant