next-gold
v0.0.5
Published
Next.js gold Ultimate SAAS starter kit
Downloads
37
Maintainers
Readme
Next.js gold Ultimate SAAS starter kit
Project likely to evolve a lot.
Under development 👨💻
Installation
npx create-next-gold-app my-project
Tech stack
- next.js
- Storybook
- Vitest
- Docker
- Eslint
- Prettier
- Husky
- Lint-staged
- Tailwind
- GrapgQL
- Prisma
- Apollo Client
Feature
- Full Stack Server Side Rendering (SSR): Utilize next.js to enable server side rendering for a seamless user experience.
- End-to-End Database Security: Implement robust security measures using Prisma to ensure the safety of user data.
- Responsive User Interface: Utilize Tailwind CSS to create a responsive and visually appealing user interface.
- Unit and Integration Testing: Use Vitest to perform thorough unit and integration testing to ensure the reliability of the application.
- Component Based Development: Employ Storybook to facilitate component-based development, allowing for reusability and efficiency.
- Code Preparation and Validation: Utilize Eslint and Prettier to ensure code consistency and quality throughout the development process.
- TypeScript for Strong Typing: Leverage TypeScript to enforce strong typing and enhance code readability and maintainability.
- Robust RESTful API Service: Use GraphQL and Apollo Client to create a robust and efficient RESTful API service.
- Easy and Reliable Deployment: Utilize Docker to simplify the deployment process and ensure reliability across different environments.
- Continuous Integration and Delivery: Utilize Husky and Lint-staged to enforce code quality checks and automate the CI/CD process.
Prerequisites
- Node.js
- Docker
- NPM
Add and edit the .env file for your database, before continuing
- Install NPM packages
npm install
- Run the app
To start the project in development, run the following command:
npm run docker:dev
to stop
Stop the app
npm run docker:down
- Run the tests
npm run test
Storybook
To run the storybook
npm run storybook
Vitest
To run the vitest
npm run test
husky
To run the husky
git commit -m "commit message"
Prisma
Generate the Prisma client by running the following command:
npx prisma generate
Migrate the database schema by running the following command:
npx prisma migrate dev
Seed the database with initial data (optional) by creating a seeds
directory and adding seed data to it. Then run the following command:
npx prisma db seed