59 | )}
60 | {description && {description}}
61 |
62 |
63 | )}
64 | {...checkboxControll}
65 | {...rest}
66 | />
67 | );
68 | }
69 |
70 | CheckboxController.defaultProps = {
71 | description: false,
72 | itemClassName: false,
73 | checkboxProps: {},
74 | };
75 |
--------------------------------------------------------------------------------
/docs/SUPPORT.md:
--------------------------------------------------------------------------------
1 | # Support and Help
2 |
3 | Need help getting started or using a project? Here's how.
4 |
5 | ## How to get help
6 |
7 | Generally, we do not use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on [Stack Overflow](https://stackoverflow.com) instead. By doing so, you are more likely to quickly solve your problem, and you will allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.
8 |
9 | Please seek support in the following ways:
10 |
11 | 1. :book: **Read the documentation and other guides** for the project to see if you can figure it out on your own. These should be located in a root `docs/` directory. If there is an example project, explore that to learn how it works to see if you can answer your question.
12 |
13 | 1. :bulb: **Search for answers and ask questions on [Stack Overflow](https://stackoverflow.com).** This is the most appropriate place for debugging issues specific to your use of the project, or figuring out how to use the project in a specific way.
14 |
15 | 1. :memo: As a **last resort**, you may open an issue on GitHub to ask for help. However, please clearly explain what you are trying to do, and list what you have already attempted to solve the problem. Provide code samples, but **do not** attach your entire project for someone else to debug. Review our [contributing guidelines](https://github.com/jessesquires/.github/blob/master/CONTRIBUTING.md).
16 |
17 | ## What NOT to do
18 |
19 | Please **do not** do any the following:
20 |
21 | 1. :x: Do not reach out to the author or contributor on Twitter (or other social media) by tweeting or sending a direct message.
22 |
23 | 1. :x: Do not email the author or contributor.
24 |
25 | 1. :x: Do not open duplicate issues or litter an existing issue with +1's.
26 |
27 | These are not appropriate avenues for seeking help or support with an open-source project. Please follow the guidelines in the previous section. Public questions get public answers, which benefits everyone in the community. ✌️
28 |
29 | ## Customer Support
30 |
31 | I do not provide any sort of "customer support" for open-source projects. However, I am available for hire. For details on contracting and consulting, visit [jessesquires.com/hire-me](https://www.jessesquires.com/hire-me/).
--------------------------------------------------------------------------------
/src/components/ui/card/card.tsx:
--------------------------------------------------------------------------------
1 | import { cn } from 'lib/utils';
2 | import * as React from 'react';
3 |
4 | const Card = React.forwardRef<
5 | HTMLDivElement,
6 | React.HTMLAttributes
7 | >(({ className, ...props }, ref) => (
8 |
16 | ));
17 | Card.displayName = 'Card';
18 |
19 | const CardHeader = React.forwardRef<
20 | HTMLDivElement,
21 | React.HTMLAttributes
22 | >(({ className, ...props }, ref) => (
23 |
28 | ));
29 | CardHeader.displayName = 'CardHeader';
30 |
31 | const CardTitle = React.forwardRef<
32 | HTMLParagraphElement,
33 | React.HTMLAttributes
34 | >(({ className, children, ...props }, ref) => (
35 |
91 | );
92 | }
93 |
94 | BreadcrumbSeparator.displayName = 'BreadcrumbSeparator';
95 |
96 | function BreadcrumbEllipsis({
97 | className,
98 | ...props
99 | }: React.ComponentProps<'span'>) {
100 | return (
101 |
107 |
108 | More
109 |
110 | );
111 | }
112 | BreadcrumbEllipsis.displayName = 'BreadcrumbElipssis';
113 |
114 | export {
115 | Breadcrumb,
116 | BreadcrumbList,
117 | BreadcrumbItem,
118 | BreadcrumbLink,
119 | BreadcrumbPage,
120 | BreadcrumbSeparator,
121 | BreadcrumbEllipsis,
122 | };
123 |
--------------------------------------------------------------------------------
/docs/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at **devtools95@gmail.com**. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 |
73 | [homepage]: https://www.contributor-covenant.org
74 |
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 |
--------------------------------------------------------------------------------
/docs/Introduction.mdx:
--------------------------------------------------------------------------------
1 | 
2 |
3 | # React + TypeScript + Vite
4 |
5 | **Project Overview:**
6 |
7 | The "apple-beyond" project aims to recreate the Apple website for educational purposes. Through this endeavor, developers gain hands-on experience with contemporary web development tools and practices.
8 |
9 | **Technologies Stack:**
10 |
11 | - **React Framework**: Empowers interactive user interface development.
12 | - **Tailwind CSS**: Efficiently styles components with a utility-first approach.
13 | - **Vite**: Rapid development is enabled through native ES modules.
14 | - **TypeScript**: Enhances code reliability and scalability with static typing.
15 | - **GSAP (GreenSock Animation Platform)**: Elevates user experience with animations.
16 | - **React Router DOM**: Facilitates seamless navigation and routing.
17 | - **React Query**: Seamlessly manages server state and data fetching.
18 | - **Sentry**: Monitors and tracks errors within the application.
19 | - **Three.js**: Renders captivating 3D graphics on the web.
20 | - **Zustand**: Provides lightweight state management for React apps.
21 | - **ESLint & Prettier**: Ensures code quality and consistency.
22 | - **PostCSS & Autoprefixer**: Enhances CSS styles for cross-browser compatibility.
23 | - **Lodash**: Simplifies JavaScript programming tasks with utility functions.
24 | - **Lucide React**: Offers a customizable set of icons for the application.
25 | - **Radix UI**: Provides accessible and composable components.
26 |
27 | **Development Practices:**
28 |
29 | - **Linting**: Maintains code quality and adherence to best practices.
30 | - **Type Checking**: Minimizes runtime errors with TypeScript's static typing.
31 | - **Continuous Integration**: Integration with CI/CD pipelines enables automated testing and deployment.
32 | - **Responsive Design**: Ensures compatibility across various devices and screen sizes.
33 |
34 | "apple-beyond" offers a comprehensive learning journey for frontend developers, encompassing a diverse range of modern technologies and development methodologies.
35 |
36 | **Project Starter Command:**
37 |
38 | 1. **Testing:**
39 |
40 | - `Runs tests using`vitest`.`:
41 |
42 | ```bash
43 | npm test
44 | ```
45 |
46 | - `Executes UI tests with `vitest --ui`.
47 |
48 | ```bash
49 | npm run test:ui
50 | ```
51 |
52 | Generates test coverage reports (`vitest run --coverage`).
53 |
54 | ```bash
55 | npm run coverage
56 | ```
57 |
58 | 2. **Development:**
59 |
60 | Starts the development server (`vite`).
61 |
62 | ```bash
63 | npm run dev
64 | ```
65 |
66 | 3. **Building:**
67 |
68 | Builds the project with TypeScript and Vite (`tsc && vite build`).
69 |
70 | ```bash
71 | npm run build
72 | ```
73 |
74 | 4. **Linting and Formatting:**
75 |
76 | Lints TypeScript and TypeScript JSX files using ESLint.
77 |
78 | ```bash
79 | npm run lint
80 | ```
81 |
82 | Formats files using Prettier.
83 |
84 | ```bash
85 | npm run prettier
86 | ```
87 |
88 | 5. **Preview:**
89 |
90 | Previews the production build (`vite preview`).
91 |
92 | ```bash
93 | npm run preview
94 | ```
95 |
96 | 6. **Storybook:**
97 |
98 | Starts Storybook in development mode.
99 |
100 | ```bash
101 | npm run storybook
102 | ```
103 |
104 | Builds Storybook for production deployment.
105 |
106 | ```bash
107 | npm run build-storybook
108 | ```
109 |
110 | 7. **Git Hooks:**
111 | Husky is configured for code quality checks and pre-commit hooks.
112 |
113 | ```bash
114 | pnpm prepare
115 | ```
116 |
--------------------------------------------------------------------------------
/src/components/ui/form/input.tsx:
--------------------------------------------------------------------------------
1 | import { cva, type VariantProps } from 'class-variance-authority';
2 | import { cn } from 'lib/utils';
3 | import { icons } from 'lucide-react';
4 | import * as React from 'react';
5 |
6 | import { Label } from './label';
7 | import { Button } from '../button/button';
8 | import { Icon, IconProps } from '../icon';
9 |
10 | const inputVariants = cva(
11 | 'flex h-10 w-full rounded-md border border-input bg-background px-3 py-2 text-sm ring-offset-background file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-offset-1 disabled:cursor-not-allowed disabled:opacity-50',
12 | {
13 | variants: {
14 | variant: {
15 | primary:
16 | 'border-primary text-primary-foreground hover:border-primary/90 placeholder-primary-foreground focus-visible:ring-ring',
17 | destructive:
18 | 'border-rose-600 focus:ring ring-rose-600 border-rose-400 hover:border-rose-600/90',
19 | outline: 'border-none',
20 | secondary: 'border-secondary hover:border-secondary/80',
21 | info: 'border-sky-500/100 text-sky-foreground hover:ring-sky-600 placeholder-sky-500/100',
22 | ghost: 'border-b',
23 | },
24 | fullWidth: { true: 'w-full' },
25 | },
26 | defaultVariants: {
27 | fullWidth: false,
28 | },
29 | }
30 | );
31 |
32 | interface InputIconProps extends IconProps {
33 | position: 'end' | 'start';
34 | onIconCLick?: () => void;
35 | }
36 |
37 | export interface InputProps
38 | extends React.InputHTMLAttributes,
39 | VariantProps {
40 | icon?: InputIconProps;
41 | fullWidth?: boolean;
42 | label?: string | React.ReactNode;
43 | labelClassName?: string;
44 | labelStyles?: React.CSSProperties;
45 | testId?: string;
46 | }
47 |
48 | const Input = React.forwardRef(
49 | (
50 | {
51 | className,
52 | fullWidth,
53 | variant,
54 | type,
55 | icon,
56 | label,
57 | labelClassName,
58 | labelStyles,
59 | testId,
60 | ...props
61 | },
62 | ref
63 | ) => {
64 | const { onIconCLick, name, position, ...restIconProps } = icon || {};
65 | return (
66 |
167 | Everything is perfect. Your account is ready and we should
168 | probably get you started!
169 |
170 | ) : null}
171 |
172 |
173 |
174 | );
175 | }
176 |
--------------------------------------------------------------------------------
/docs/Todo.mdx:
--------------------------------------------------------------------------------
1 |
2 | ## I Need setup this techs
3 |
4 | With this template, you get all the awesomeness you need:
5 |
6 | - 💅 **[Tailwind CSS](https://tailwindcss.com/)** - A utility-first CSS framework for rapid UI development
7 | - ✨ **[ESlint](https://eslint.org/)** and **[Prettier](https://prettier.io/)** - For clean, consistent, and error-free code
8 | - 🛠️ **[Extremely strict TypeScript](https://www.typescriptlang.org/)** - With [`ts-reset`](https://github.com/total-typescript/ts-reset) library for ultimate type safety
9 | - 🚀 **[GitHub Actions](https://github.com/features/actions)** - Pre-configured actions for smooth workflows, including Bundle Size and performance stats
10 | - 💯 **Perfect Lighthouse score** - Because performance matters
11 | - **[Bundle analyzer plugin](https://www.npmjs.com/package/@next/bundle-analyzer)** - Keep an eye on your bundle size
12 | - **[Jest](https://jestjs.io/)** and **[React Testing Library](https://testing-library.com/react)** - For rock-solid unit and integration tests
13 | - **[Playwright](https://playwright.dev/)** - Write end-to-end tests like a pro
14 | - **[Storybook](https://storybook.js.org/)** - Create, test, and showcase your components
15 | - **Smoke Testing** and **Acceptance Tests** - For confidence in your deployments
16 | - **[Conventional commits git hook](https://www.conventionalcommits.org/)** - Keep your commit history neat and tidy
17 | - **[Observability](https://opentelemetry.io/)** - Open Telemetry integration for seamless monitoring
18 | - **[Absolute imports](https://nextjs.org/docs/advanced-features/module-path-aliases)** - No more spaghetti imports
19 | - **[Health checks](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)** - Kubernetes-compatible for robust deployments
20 | - **[Radix UI](https://www.radix-ui.com/)** - Headless UI components for endless customization
21 | - **[CVA](http://cva.style/)** - Create a consistent, reusable, and atomic design system
22 | - **[Renovate BOT](https://www.whitesourcesoftware.com/free-developer-tools/renovate)** - Auto-updating dependencies, so you can focus on coding
23 | - **[Patch-package](https://www.npmjs.com/package/patch-package)** - Fix external dependencies without losing your mind
24 | - **Components coupling and cohesion graph** - A tool for managing component relationships
25 | - **[Automated ChatGPT Code Reviews](https://openai.com/chatgpt)** - **Stay on the cutting edge with AI-powered code reviews!**
26 | - **[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog
27 | - **[T3 Env](https://env.t3.gg/)** - Manage your environment variables with ease
28 |
29 | ## Table of Contents
30 | - [Features](#features)
31 | - [Table of Contents](#table-of-contents)
32 | - [🎯 Getting Started](#-getting-started)
33 | - [🚀 Deployment](#-deployment)
34 | - [📃 Scripts Overview](#-scripts-overview)
35 | - [🔗 Coupling Graph](#-coupling-graph)
36 | - [🧪 Testing](#-testing)
37 | - [Running Tests](#running-tests)
38 | - [Acceptance Tests](#acceptance-tests)
39 | - [Smoke Testing](#smoke-testing)
40 | - [🎨 Styling and Design System](#-styling-and-design-system)
41 | - [CVA - A New Approach to Variants](#cva---a-new-approach-to-variants)
42 | - [💾 State Management](#-state-management)
43 | - [Zustand](#zustand)
44 | - [Jotai](#jotai)
45 | - [Recoil](#recoil)
46 | - [🤖 ChatGPT Code Review](#-chatgpt-code-review)
47 | - [💻 Environment Variables handling](#-environment-variables-handling)
48 | - [🤝 Contribution](#-contribution)
49 | - [Support](#support)
50 | - [📜 License](#-license)
51 | - [Contributors](#contributors)
52 | - [project technology](#project-technology)
53 | - [url: "https://next-enterprise.vercel.app/",](#url-httpsnext-enterprisevercelapp)
54 |
55 | ## 🎯 Getting Started
56 |
57 | To get started with this boilerplate, follow these steps:
58 |
59 | 2. Install the dependencies:
60 |
61 | ```bash
62 | pnpm install --frozen-lockfile
63 | ```
64 |
65 | 3. Run the development server:
66 |
67 | ```bash
68 | pnpm dev
69 | ```
70 |
71 | 4. Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.
72 |
73 | 5. This project uses a git hook to enforce [conventional commits](https://github.com/qoomon/git-conventional-commits). To install the git hook, run the following command in the root directory of the project:
74 |
75 | ```sh
76 | brew install pre-commit
77 | pre-commit install -t commit-msg
78 | ```
79 |
80 | ## 🚀 Deployment
81 |
82 | Easily deploy your react.js app with [Vercel](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=github&utm_campaign=next-enterprise) by clicking the button below:
83 |
84 | [](https://vercel.com/new/git/external?repository-url=https://github.com/Blazity/next-enterprise)
85 |
86 | ## 📃 Scripts Overview
87 |
88 | The following scripts are available in the `package.json`:
89 |
90 | - `dev`: Starts the development server with colorized output
91 | - `build`: Builds the app for production
92 | - `start`: Starts the production server
93 | - `lint`: Lints the code using ESLint
94 | - `lint:fix`: Automatically fixes linting errors
95 | - `prettier`: Checks the code for proper formatting
96 | - `prettier:fix`: Automatically fixes formatting issues
97 | - `analyze`: Analyzes the bundle sizes for Client, Server and Edge environments
98 | - `storybook`: Starts the Storybook server
99 | - `build-storybook`: Builds the Storybook for deployment
100 | - `test`: Runs unit and integration tests
101 | - `e2e:headless`: Runs end-to-end tests in headless mode
102 | - `e2e:ui`: Runs end-to-end tests with UI
103 | - `format`: Formats the code with Prettier
104 | - `postinstall`: Applies patches to external dependencies
105 | - `preinstall`: Ensures the project is installed with Yarn
106 | - `coupling-graph`: **Generates a coupling and cohesion graph for the components**
107 |
108 | ## 🔗 Coupling Graph
109 |
110 | The `coupling-graph` script is a useful tool that helps visualize the coupling and connections between your project's internal modules. It's built using the [Madge](https://github.com/pahen/madge) library. To generate the graph, simply run the following command:
111 |
112 | ```bash
113 | yarn coupling-graph
114 | ```
115 |
116 | This will create a `graph.svg` file, which contains a graphical representation of the connections between your components. You can open the file with any SVG-compatible viewer.
117 |
118 | 
119 |
120 | ## 💻 Environment Variables handling
121 |
122 | [T3 Env](https://env.t3.gg/) is a library that provides environmental variables checking at build time, type validation and transforming. It ensures that your application is using the correct environment variables and their values are of the expected type. You’ll never again struggle with runtime errors caused by incorrect environment variable usage.
123 |
124 | Config file is located at `env.mjs`. Simply set your client and server variables and import `env` from any file in your project.
125 |
126 | ```ts
127 | export const env = createEnv({
128 | server: {
129 | // Server variables
130 | SECRET_KEY: z.string(),
131 | },
132 | client: {
133 | // Client variables
134 | API_URL: z.string().url(),
135 | },
136 | runtimeEnv: {
137 | // Assign runtime variables
138 | SECRET_KEY: process.env.SECRET_KEY,
139 | API_URL: process.env.NEXT_PUBLIC_API_URL,
140 | },
141 | });
142 | ```
143 |
144 | If the required environment variables are not set, you'll get an error message:
145 |
146 | ```sh
147 | ❌ Invalid environment variables: { SECRET_KEY: [ 'Required' ] }
148 | ```
149 |
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 |
4 | [](https://discord.gg/zSQGy8Aq)
5 | 
6 | 
7 |
8 |
9 |
10 |
11 |
12 |
React Launchpad open-source codebase
13 |
14 |
15 | ## Table of Contents
16 |
17 | - [Getting Started](#getting-started)
18 | - [Introduction](#introduction)
19 | - [Development Tools](#development-tools)
20 | - [Testing](#testing)
21 | - [Deployment](#deployment)
22 | - [Scripts Overview](#scripts-overview)
23 | - [Roadmap](#roadmap)
24 | - [UI](#ui)
25 | - [Hooks and Utilities](#hooks-and-utilities)
26 | - [Code Quality](#code-quality)
27 | - [Testing app](#testing-app)
28 | - [Contributing](#contributing)
29 | - [Platform, Build, and Deployment Status](#platform-build-and-deployment-status)
30 | - [License](#license)
31 |
32 | ## Introduction
33 |
34 | React Launchpad is a modern React project starter setup aimed at simplifying the initial setup for React projects. It provides a streamlined starting point with pre-configured tools and dependencies to kickstart your development process.
35 |
36 | ## Getting Started
37 |
38 | To get started with this app, follow these steps:
39 |
40 | To get started with this app, follow these steps:
41 |
42 | 1. Fork & clone the repository:
43 |
44 | ```bash
45 | git clone https://github.com//react-launchpad.git
46 | ```
47 |
48 | 2. Install the dependencies:
49 |
50 | ```bash
51 | pnpm install
52 | ```
53 |
54 | 3. Run the development server:
55 |
56 | ```bash
57 | pnpm dev
58 | ```
59 |
60 | 4. Open [http://localhost:3000](http://localhost:5173) with your browser to see the result.
61 |
62 |
63 |
64 |
65 | > [!NOTE]
66 | > I use [Neode](https://github.com/adam-cowley/neode) for managing application data in this project. Ensure that
67 |
68 |
69 | ## 📃 Scripts Overview
70 |
71 | The following scripts are available in the `package.json`:
72 |
73 | - `dev`: Starts the development server with colorized output
74 | - `build`: Builds the app for production
75 | - `start`: Starts the production server
76 | - `format`: Formats the code with Prettier
77 | - `lint`: Lints the code using ESLint
78 | - `lint:fix`: Automatically fixes linting errors
79 | - `prettier`: Checks the code for proper formatting
80 | - `prettier:fix`: Automatically fixes formatting issues
81 | - `story`: Starts the Storybook server
82 | - `build-story`: Builds the Storybook for deployment
83 | - `test`: Runs unit and integration tests
84 | - `test:ui`: Runs end-to-end tests in headless mode
85 | - `coverage`: checking for how many of your code is tested
86 |
87 |
88 |
89 |
90 | ## Roadmap
91 |
92 |
93 | - [ ] **Update documentation for installation & configuration**: This is currently a work in progress. Enhancing documentation ensures smoother onboarding for new contributors and users. Focus on clarity, completeness, and providing examples where necessary.\
94 |
95 | - [ ] **Create a starter app and show how folder structure and explain how the project work**: This is currently a work in progress.
96 |
97 | - [] **Enhance Testing Coverage**: Consider expanding test coverage, especially for critical functionalities. Incorporate unit tests, integration tests, and end-to-end tests to ensure robustness and reliability.
98 |
99 | - [] **Streamline Development Workflow**: Evaluate the existing development process and tooling. Identify areas where automation can be introduced to streamline repetitive tasks and improve developer productivity.
100 |
101 | - [] **Address Technical Debt**: Take time to address any accumulated technical debt. Refactor code, resolve code smells, and optimize performance to maintain codebase health and sustainability.
102 |
103 | - [] **Community Engagement**: Foster community engagement by encouraging contributions, providing clear contribution guidelines, and actively participating in relevant forums or communities related to your project.
104 |
105 | - [] **Accessibility and Internationalization**: Assess the accessibility and internationalization aspects of your project. Ensure that the application is accessible to users with disabilities and supports multiple languages for a broader user base.
106 |
107 | - [] **Performance Optimization**: Continuously monitor and optimize application performance. Implement techniques such as code splitting, lazy loading, and caching to enhance user experience and reduce load times.
108 |
109 | By following this roadmap and implementing the suggested improvements, you can enhance the overall quality, maintainability, and user satisfaction of your project.
110 |
111 |
112 |
113 |
114 | ### UI
115 |
116 | - [Tailwind CSS](https://tailwindcss.com/) – Utility-first CSS framework for rapid UI development
117 | - [Shadcn/ui](https://ui.shadcn.com/) – Re-usable components built using Radix UI and Tailwind CSS
118 | - [Framer Motion](https://framer.com/motion) – Motion library for React to animate components with ease
119 | - [Lucide](https://lucide.dev/) – Beautifully simple, pixel-perfect icons
120 | - [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) – Optimize custom fonts and remove external network requests for improved performance
121 | - [`ImageResponse`](https://nextjs.org/docs/app/api-reference/functions/image-response) – Generate dynamic Open Graph images at the edge
122 |
123 |
124 |
125 | ### Hooks and Utilities
126 |
127 | - `useIntersectionObserver` – React hook to observe when an element enters or leaves the viewport
128 | - `useLocalStorage` – Persist data in the browser's local storage
129 | - `useScroll` – React hook to observe scroll position ([example](https://github.com/mickasmt/precedent/blob/main/components/layout/navbar.tsx#L12))
130 | - `nFormatter` – Format numbers with suffixes like `1.2k` or `1.2M`
131 | - `capitalize` – Capitalize the first letter of a string
132 | - `truncate` – Truncate a string to a specified length
133 | - [`use-debounce`](https://www.npmjs.com/package/use-debounce) – Debounce a function call / state update
134 |
135 |
136 | ### Code Quality
137 |
138 | - [TypeScript](https://www.typescriptlang.org/) – Static type checker for end-to-end typesafety
139 | - [Prettier](https://prettier.io/) – Opinionated code formatter for consistent code style
140 | - [ESLint](https://eslint.org/) – Pluggable linter for Next.js and TypeScript
141 |
142 |
143 |
144 | ### Testing app
145 |
146 | Mocking api for test perposes with fakerjs and msw.
147 |
148 | Run a test like a pro with and vitest ui and react testing library.
149 |
150 | 
151 |
152 | Integrate type checking and eslint and commitlint and husky for caching errors in compile time.
153 |
154 |
155 | ## 🚀 Deployment
156 |
157 | Easily deploy your React.js app with [Vercel](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=github&utm_campaign=next-enterprise) by clicking the button below:
158 |
159 | [](https://vercel.com/new/git/external?repository-url=https://github.com/Blazity/next-enterprise)
160 |
161 |
162 |
163 | ### Contributing
164 |
165 | The devtools community is possible thanks to thousands of kind volunteers like you. We welcome all contributions to the community and are excited to welcome you aboard.
166 |
167 | > #### [Please follow these steps to contribute](https://react-launchpad.vercel.app/contribute).
168 |
169 | Recent Contributions:
170 |
171 | 
172 |
173 | ### Platform, Build, and Deployment Status
174 |
175 | The general platform status for all our applications is available at [`https://react-launchpad.vercel.app/status`](https://react-launchpad.vercel.app). The build and deployment status for the code is available in [our DevOps Guide](https://react-launchpad.vercel.app/devops).
176 |
177 |
--------------------------------------------------------------------------------
/public/logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
--------------------------------------------------------------------------------
/docs/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to [react-launchpad]
2 |
3 | We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4 |
5 | • Reporting a bug
6 |
7 | • Discussing the current state of the code
8 |
9 | • Submitting a fix
10 |
11 | • Proposing new features
12 |
13 | • Becoming a maintainer
14 |
15 |
16 | ## We Develop with Github
17 |
18 | We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
19 |
20 | ## We Use Github Flow, So All Code Changes Happen Through Pull Requests
21 |
22 | Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
23 |
24 | 1. Fork the repo and create your branch from `main`.
25 | 2. If you've added code that should be tested, add tests.
26 | 3. If you've changed APIs, update the documentation.
27 | 4. Ensure the test suite passes.
28 | 5. Make sure your code lints.
29 | 6. Issue that pull request!
30 |
31 | ## Any contributions you make will be under the Software License
32 |
33 | In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
34 |
35 | ## Report bugs using Github's issues
36 |
37 | We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
38 |
39 | ## Write bug reports with detail, background, and sample code
40 |
41 | [**Great Bug Reports**](https://www.bing.com/search?form=SKPBOT&q=Great%20Bug%20Reports) tend to have:
42 |
43 | • A quick summary and/or background
44 |
45 | • Steps to reproduce
46 |
47 | • Be specific!
48 |
49 | • Give sample code if you can.
50 |
51 | • What you expected would happen
52 |
53 | • What actually happens
54 |
55 | • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
56 |
57 |
58 | People *love* thorough bug reports.
59 |
60 | ## Use a Consistent Coding Style
61 |
62 | * 2 spaces for indentation rather than tabs
63 | * You can try running `npm run lint` for style unification
64 |
65 | ## License
66 |
67 | By contributing, you agree that your contributions will be licensed under its MIT License.
68 |
69 | ## References
70 |
71 | This document was adapted from the open-source contribution guidelines for Facebook's Draft.
72 |
73 |
74 | # Contributing Guidelines
75 |
76 | *Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!* :octocat:
77 |
78 | ### Contents
79 |
80 | - [Code of Conduct](#book-code-of-conduct)
81 | - [Asking Questions](#bulb-asking-questions)
82 | - [Opening an Issue](#inbox_tray-opening-an-issue)
83 | - [Feature Requests](#love_letter-feature-requests)
84 | - [Triaging Issues](#mag-triaging-issues)
85 | - [Submitting Pull Requests](#repeat-submitting-pull-requests)
86 | - [Writing Commit Messages](#memo-writing-commit-messages)
87 | - [Code Review](#white_check_mark-code-review)
88 | - [Coding Style](#nail_care-coding-style)
89 | - [Certificate of Origin](#medal_sports-certificate-of-origin)
90 | - [Credits](#pray-credits)
91 |
92 | > **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.**
93 |
94 | ## :book: Code of Conduct
95 |
96 | Please review our [Code of Conduct](https://github.com/jessesquires/.github/blob/main/CODE_OF_CONDUCT.md). It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting like an asshole will not be tolerated.
97 |
98 | ## :bulb: Asking Questions
99 |
100 | See our [Support Guide](https://github.com/jessesquires/.github/blob/main/SUPPORT.md). In short, GitHub issues are not the appropriate place to debug your specific project, but should be reserved for filing bugs and feature requests.
101 |
102 | ## :inbox_tray: Opening an Issue
103 |
104 | Before [creating an issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue), check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.
105 |
106 | ### :lock: Reporting Security Issues
107 |
108 | Review our [Security Policy](https://github.com/jessesquires/.github/blob/main/SECURITY.md). **Do not** file a public issue for security vulnerabilities.
109 |
110 | ### :beetle: Bug Reports and Other Issues
111 |
112 | A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. :v:
113 |
114 | In short, since you are most likely a developer, **provide a ticket that you would like to receive**.
115 |
116 | - **Review the documentation and [Support Guide](https://github.com/jessesquires/.github/blob/main/SUPPORT.md)** before opening a new issue.
117 |
118 | - **Do not open a duplicate issue!** Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests.
119 |
120 | - **Prefer using [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)**, not comments, if you simply want to "+1" an existing issue.
121 |
122 | - **Fully complete the provided issue template.** The bug report template requests all the information we need to quickly and efficiently address your issue. Be clear, concise, and descriptive. Provide as much information as you can, including steps to reproduce, stack traces, compiler errors, library versions, OS versions, and screenshots (if applicable).
123 |
124 | - **Use [GitHub-flavored Markdown](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).** Especially put code blocks and console outputs in backticks (```). This improves readability.
125 |
126 | ## :love_letter: Feature Requests
127 |
128 | Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep). Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!
129 |
130 | - **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.
131 |
132 | - **Fully complete the provided issue template.** The feature request template asks for all necessary information for us to begin a productive conversation.
133 |
134 | - Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.
135 |
136 | ## :mag: Triaging Issues
137 |
138 | You can triage issues which may include reproducing bug reports or asking for additional information, such as version numbers or reproduction instructions. Any help you can provide to quickly resolve an issue is very much appreciated!
139 |
140 | ## :repeat: Submitting Pull Requests
141 |
142 | We **love** pull requests! Before [forking the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue.
143 |
144 | For most contributions, after your first pull request is accepted and merged, you will be [invited to the project](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) and given **push access**. :tada:
145 |
146 | *Note: All contributions will be licensed under the project's license.*
147 |
148 | - **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether.
149 |
150 | - **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing!
151 |
152 | - **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it.
153 |
154 | - **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. When possible, these will be enforced with a linter. Consistency makes it easier to review and modify in the future.
155 |
156 | - **Include test coverage.** Add unit tests or UI tests when possible. Follow existing patterns for implementing tests.
157 |
158 | - **Update the example project** if one exists to exercise any new functionality you have added.
159 |
160 | - **Add documentation.** Document your changes with code doc comments or in existing guides.
161 |
162 | - **Update the CHANGELOG** for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @jessesquires")
163 |
164 | - **Use the repo's default branch.** Branch from and [submit your pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the repo's default branch. Usually this is `main`, but it could be `dev`, `develop`, or `master`.
165 |
166 | - **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur.
167 |
168 | - **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it.
169 |
170 | - When writing comments, use properly constructed sentences, including punctuation.
171 |
172 | - Use spaces, not tabs.
173 |
174 | ## :memo: Writing Commit Messages
175 |
176 | Please [write a great commit message](https://chris.beams.io/posts/git-commit/).
177 |
178 | 1. Separate subject from body with a blank line
179 | 1. Limit the subject line to 50 characters
180 | 1. Capitalize the subject line
181 | 1. Do not end the subject line with a period
182 | 1. Use the imperative mood in the subject line (example: "Fix networking issue")
183 | 1. Wrap the body at about 72 characters
184 | 1. Use the body to explain **why**, *not what and how* (the code shows that!)
185 | 1. If applicable, prefix the title with the relevant component name. (examples: "[Docs] Fix typo", "[Profile] Fix missing avatar")
186 |
187 | ```
188 | [TAG] Short summary of changes in 50 chars or less
189 |
190 | Add a more detailed explanation here, if necessary. Possibly give
191 | some background about the issue being fixed, etc. The body of the
192 | commit message can be several paragraphs. Further paragraphs come
193 | after blank lines and please do proper word-wrap.
194 |
195 | Wrap it to about 72 characters or so. In some contexts,
196 | the first line is treated as the subject of the commit and the
197 | rest of the text as the body. The blank line separating the summary
198 | from the body is critical (unless you omit the body entirely);
199 | various tools like `log`, `shortlog` and `rebase` can get confused
200 | if you run the two together.
201 |
202 | Explain the problem that this commit is solving. Focus on why you
203 | are making this change as opposed to how or what. The code explains
204 | how or what. Reviewers and your future self can read the patch,
205 | but might not understand why a particular solution was implemented.
206 | Are there side effects or other unintuitive consequences of this
207 | change? Here's the place to explain them.
208 |
209 | - Bullet points are okay, too
210 |
211 | - A hyphen or asterisk should be used for the bullet, preceded
212 | by a single space, with blank lines in between
213 |
214 | Note the fixed or relevant GitHub issues at the end:
215 |
216 | Resolves: #123
217 | See also: #456, #789
218 | ```
219 |
220 | ## :white_check_mark: Code Review
221 |
222 | - **Review the code, not the author.** Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning.
223 |
224 | - **You are not your code.** When your code is critiqued, questioned, or constructively criticized, remember that you are not your code. Do not take code review personally.
225 |
226 | - **Always do your best.** No one writes bugs on purpose. Do your best, and learn from your mistakes.
227 |
228 | - Kindly note any violations to the guidelines specified in this document.
229 |
230 | ## :nail_care: Coding Style
231 |
232 | Consistency is the most important. Following the existing style, formatting, and naming conventions of the file you are modifying and of the overall project. Failure to do so will result in a prolonged review process that has to focus on updating the superficial aspects of your code, rather than improving its functionality and performance.
233 |
234 | For example, if all private properties are prefixed with an underscore `_`, then new ones you add should be prefixed in the same way. Or, if methods are named using camelcase, like `thisIsMyNewMethod`, then do not diverge from that by writing `this_is_my_new_method`. You get the idea. If in doubt, please ask or search the codebase for something similar.
235 |
236 | When possible, style and format will be enforced with a linter.
237 |
238 | ## :medal_sports: Certificate of Origin
239 |
240 | *Developer's Certificate of Origin 1.1*
241 |
242 | By making a contribution to this project, I certify that:
243 |
244 | > 1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
245 | > 1. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
246 | > 1. The contribution was provided directly to me by some other person who certified (1), (2) or (3) and I have not modified it.
247 | > 1. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
248 |
249 | ## [No Brown M&M's](https://en.wikipedia.org/wiki/Van_Halen#Contract_riders)
250 |
251 | If you are reading this, bravo dear user and (hopefully) contributor for making it this far! You are awesome. :100:
252 |
253 | To confirm that you have read this guide and are following it as best as possible, **include this emoji at the top** of your issue or pull request: :black_heart: `:black_heart:`
254 |
255 | ## :pray: Credits
256 |
257 | Written by [@jessesquires](https://github.com/jessesquires).
258 |
259 | **Please feel free to adopt this guide in your own projects. Fork it wholesale or remix it for your needs.**
260 |
261 | *Many of the ideas and prose for the statements in this document were based on or inspired by work from the following communities:*
262 |
263 | - [Alamofire](https://github.com/Alamofire/Alamofire/blob/master/CONTRIBUTING.md)
264 | - [CocoaPods](https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md)
265 | - [Docker](https://github.com/moby/moby/blob/master/CONTRIBUTING.md)
266 | - [Linux](https://elinux.org/Developer_Certificate_Of_Origin)
267 |
268 | *We commend them for their efforts to facilitate collaboration in their projects.*
--------------------------------------------------------------------------------