Skip to content

Rive branch PR #21

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

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,7 @@
"eslint:recommended",
"prettier"
],
"plugins": [
"@typescript-eslint",
"react",
"jsx-a11y"
],
"plugins": ["@typescript-eslint", "react", "jsx-a11y"],
"rules": {
"react/react-in-jsx-scope": "off",
"jsx-a11y/anchor-is-valid": "off",
Expand All @@ -38,4 +34,4 @@
"version": "detect"
}
}
}
}
18 changes: 10 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand All @@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'

- name: Install dependencies
run: npm install

Expand All @@ -37,6 +37,6 @@ jobs:
# run: npm run test
# env:
# CI: true

- name: Build project
run: npm run build
run: npm run build
2 changes: 1 addition & 1 deletion .lintstagedrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"]
}
}
19 changes: 9 additions & 10 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
{
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"printWidth": 80,
"tabWidth": 2,
"bracketSpacing": true,
"arrowParens": "always",
"endOfLine": "auto"
}

"semi": true,
"singleQuote": true,
"trailingComma": "all",
"printWidth": 80,
"tabWidth": 2,
"bracketSpacing": true,
"arrowParens": "always",
"endOfLine": "auto"
}
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{
}
22 changes: 11 additions & 11 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand Down
95 changes: 51 additions & 44 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,70 @@
# Contributing to Next.js Starter Kit

Thank you for considering contributing to the Next.js Starter Kit! 🎉 Your input is invaluable in improving this project and making it even better for the community.
Thank you for considering contributing to the Next.js Starter Kit! 🎉 Your input is invaluable in improving this project and making it even better for the community.

## How to Contribute

### 1. Fork the Repository
### 1. Fork the Repository

- Click the "Fork" button at the top of this repository.
- Clone your fork to your local machine:
- Clone your fork to your local machine:
```
git clone https://github.com/your-username/nextjs-starter-kit.git
```
```
cd nextjs-starter-kit
```

### 2. Create a New Branch
- Create a feature or bugfix branch:
```
git checkout -b feature-name
```

### 3. Make Changes
- Implement your changes.
- Write or update tests if applicable.
- Run the project locally to ensure everything works as expected:
```
npm install
npm run dev
```

### 4. Test Your Changes
-Run linting and tests to ensure code quality and stability:
```
npm run lint
### 2. Create a New Branch

- Create a feature or bugfix branch:
```
git checkout -b feature-name
```

### 3. Make Changes

- Implement your changes.
- Write or update tests if applicable.
- Run the project locally to ensure everything works as expected:
```
npm install
npm run dev
```

### 4. Test Your Changes

-Run linting and tests to ensure code quality and stability:
` npm run lint
npm run test
```

### 5. Commit and Push
- Commit your changes with a meaningful message:
```
git commit -m "Add feature-name or fix issue #issue-number"
```
- Push your branch to your fork:
```
git push origin feature-name
```

### 6. Create a Pull Request
- Go to the original repository.
- Click *"New Pull Request"* and select your branch.
- Fill out the pull request template with details about your changes.
`

### 5. Commit and Push

- Commit your changes with a meaningful message:
```
git commit -m "Add feature-name or fix issue #issue-number"
```
- Push your branch to your fork:
```
git push origin feature-name
```

### 6. Create a Pull Request

- Go to the original repository.
- Click _"New Pull Request"_ and select your branch.
- Fill out the pull request template with details about your changes.

## Guidelines for Contributions
- **Be Clear** : Describe the problem or feature in detail in your pull request.
- **Respect Code Quality** : Follow the project's coding standards and ensure your code passes linting.
- Keep It Simple: Focus on small, focused changes instead of big, sweeping ones.
- **Collaborate** : If you're not sure how to approach an issue, feel free to discuss it in the Issues section.

- **Be Clear** : Describe the problem or feature in detail in your pull request.
- **Respect Code Quality** : Follow the project's coding standards and ensure your code passes linting.
- Keep It Simple: Focus on small, focused changes instead of big, sweeping ones.
- **Collaborate** : If you're not sure how to approach an issue, feel free to discuss it in the Issues section.

## Feedback and Support
If you encounter any issues or have questions, feel free to open a new issue in the repository.

Thank you for helping make the Next.js Starter Kit awesome! 💪
If you encounter any issues or have questions, feel free to open a new issue in the repository.

Thank you for helping make the Next.js Starter Kit awesome! 💪
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,23 @@ Clone the repository, install dependencies, and start the development server.
```bash
git clone https://github.com/aelabid/Next-StarterKit.git
```

```bash
cd Next-StarterKit
```

```bash
npm install
```

```bash
npm run dev
```

Open http://localhost:3000 to view it in the browser.

## 📂 Folder Structure :

```bash
├── app/
│ ├── (routes)/
Expand All @@ -53,26 +57,33 @@ Open http://localhost:3000 to view it in the browser.
└── i18n/
```


## 🛠️ Technologies Used :

- **React Query** for API requests
- **Redux** for local state
- **Jest & Storybook** for testing
- **Tailwind CSS** for styling

## 🏁 Getting Started :

Running Tests
- *Run unit tests with Jest:*

- _Run unit tests with Jest:_

```bash
npm run test
```
- *Run end-to-end tests with Cypress:*

- _Run end-to-end tests with Cypress:_

```bash
npm run cypress:open
```

## 🤝 Contributing :

We welcome contributions! Please follow our contributing guidelines and adhere to the code of conduct.

## 📝 License :

Distributed under the MIT License. See LICENSE for more information.
15 changes: 10 additions & 5 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Security Policy

## Supported Versions

We actively support and provide security updates for the following versions of the Next.js Starter Kit:

| Version | Supported |
|---------|--------------------|
| 1.x | ✅ |
| < 1.0 | ❌ |
| Version | Supported |
| ------- | --------- |
| 1.x | ✅ |
| < 1.0 | ❌ |

## Reporting a Vulnerability

If you discover a security vulnerability in this project, please report it responsibly. Here's how:

1. **Do not create a public issue** to report the vulnerability.
Expand All @@ -22,13 +24,16 @@ We aim to respond to vulnerability reports within **48 hours** and will work wit
---

## Our Commitment

We take security seriously and are committed to:

- Investigating all reports thoroughly.
- Keeping reporters updated on the status of their report.
- Providing patches or workarounds to fix security issues promptly.

---

## Additional Guidelines

- For general questions about the project, please use the [Discussions](https://github.com/asmaelabid/nextjs-starter-kit/discussions) or Issues section.
- For non-security bugs, report them via [GitHub Issues](https://github.com/asmaelabid/nextjs-starter-kit/issues).
- For non-security bugs, report them via [GitHub Issues](https://github.com/asmaelabid/nextjs-starter-kit/issues).
Loading