Welcome to the Sabat Next.js TypeScript Redux Jest Cypress Starter! This repository provides a well-structured, production-ready boilerplate for building web applications using Next.js, TypeScript, Redux, Jest, Cypress, and more. Whether you're starting a new project or looking to enhance your existing applications, this starter kit has you covered.
- Next.js: A powerful React framework for building server-rendered applications.
- TypeScript: Adds type safety to your JavaScript code, improving maintainability and reducing bugs.
- Redux: State management for your React applications, allowing for predictable state updates.
- Jest: A testing framework for JavaScript, perfect for unit and integration tests.
- Cypress: End-to-end testing tool that makes testing your web applications easy and reliable.
- Mongoose: An ODM (Object Data Modeling) library for MongoDB and Node.js.
- ESLint: A static code analysis tool to identify problematic patterns in JavaScript code.
- Prettier: A code formatter that enforces a consistent style across your codebase.
- Tailwind CSS: A utility-first CSS framework for rapid UI development.
- Bundle Analyzer: A tool to visualize the size of webpack output files.
- Storybook: A tool for developing UI components in isolation.
To get started with this boilerplate, follow these steps:
-
Clone the Repository
Use the following command to clone the repository:
git clone https://github.com/DanielVilleda/sabat-nextjs-typescript-redux-jest-cypress-starter.git
-
Navigate to the Directory
Change into the project directory:
cd sabat-nextjs-typescript-redux-jest-cypress-starter
-
Install Dependencies
Install the required packages using npm or yarn:
npm install
or
yarn install
-
Run the Development Server
Start the development server:
npm run dev
or
yarn dev
Your application will be running at
http://localhost:3000
. -
Open in Your Browser
Visit
http://localhost:3000
to see your application in action.
To run the tests, use the following command:
npm test
or
yarn test
This will execute your Jest tests. For end-to-end tests using Cypress, run:
npm run cypress
or
yarn cypress
To create a production build of your application, run:
npm run build
or
yarn build
This command will generate an optimized version of your application in the .next
directory.
For detailed documentation on each tool and library included in this boilerplate, please refer to the following links:
- Next.js Documentation
- TypeScript Documentation
- Redux Documentation
- Jest Documentation
- Cypress Documentation
- Mongoose Documentation
- ESLint Documentation
- Prettier Documentation
- Tailwind CSS Documentation
- Bundle Analyzer Documentation
- Storybook Documentation
This repository covers the following topics:
- cypress
- daisyui
- docker
- eslint
- jest
- mongodb
- nextjs
- nextjs-boilerplate
- nextjs-redux-boilerplate
- prettier
- react
- react-testing-library
- redux
- redux-toolkit
- storybook
- tailwindcss
For the latest releases, visit the Releases section. Here, you can download the latest version and view release notes.
We welcome contributions to this project! If you have suggestions or improvements, please fork the repository and submit a pull request.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/YourFeature
). - Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature/YourFeature
). - Open a pull request.
For questions or feedback, please reach out via the issues section of this repository.
This project is licensed under the MIT License. See the LICENSE file for details.
- Thanks to the open-source community for providing the tools and libraries that make web development easier and more efficient.
Explore the power of Next.js with TypeScript and Redux using this starter kit. For more information and updates, check the Releases section. Happy coding!