This repository has been archived by the owner on Nov 13, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 549c3d7
Showing
92 changed files
with
5,748 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
.next | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
// eslint-disable-next-line @typescript-eslint/no-var-requires | ||
const fs = require("fs") | ||
|
||
module.exports = { | ||
extends: [ | ||
"next", | ||
"prettier", | ||
"plugin:@typescript-eslint/recommended", | ||
"plugin:tailwindcss/recommended", | ||
], | ||
parserOptions: { | ||
babelOptions: { | ||
presets: [require.resolve("next/babel")], | ||
}, | ||
}, | ||
rules: { | ||
"testing-library/prefer-screen-queries": "off", | ||
"@next/next/no-html-link-for-pages": "off", | ||
"@typescript-eslint/no-unused-vars": [ | ||
"warn", | ||
{ | ||
argsIgnorePattern: "^_", | ||
varsIgnorePattern: "^_", | ||
}, | ||
], | ||
"sort-imports": [ | ||
"error", | ||
{ | ||
ignoreCase: true, | ||
ignoreDeclarationSort: true, | ||
}, | ||
], | ||
"tailwindcss/classnames-order": "off", | ||
"import/order": [ | ||
1, | ||
{ | ||
groups: ["external", "builtin", "internal", "sibling", "parent", "index"], | ||
pathGroups: [ | ||
...getDirectoriesToSort().map((singleDir) => ({ | ||
pattern: `${singleDir}/**`, | ||
group: "internal", | ||
})), | ||
{ | ||
pattern: "env", | ||
group: "internal", | ||
}, | ||
{ | ||
pattern: "theme", | ||
group: "internal", | ||
}, | ||
{ | ||
pattern: "public/**", | ||
group: "internal", | ||
position: "after", | ||
}, | ||
], | ||
pathGroupsExcludedImportTypes: ["internal"], | ||
alphabetize: { | ||
order: "asc", | ||
caseInsensitive: true, | ||
}, | ||
}, | ||
], | ||
}, | ||
} | ||
|
||
function getDirectoriesToSort() { | ||
const ignoredSortingDirectories = [".git", ".next", ".vscode", "node_modules"] | ||
return getDirectories(process.cwd()).filter((f) => !ignoredSortingDirectories.includes(f)) | ||
} | ||
|
||
function getDirectories(path) { | ||
return fs.readdirSync(path).filter(function (file) { | ||
return fs.statSync(path + "/" + file).isDirectory() | ||
}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.js | ||
|
||
# testing | ||
/coverage | ||
|
||
# next.js | ||
/.next/ | ||
/out/ | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
*.pem | ||
|
||
# debug | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# local env files | ||
.env*.local | ||
|
||
# vercel | ||
.vercel | ||
|
||
# typescript | ||
*.tsbuildinfo | ||
next-env.d.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
enable-pre-post-scripts=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
18 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
.next | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
# Code of Conduct | ||
|
||
## Conventional Commits | ||
|
||
Developers should use the Conventional Commits standard when committing changes to the codebase. | ||
|
||
| Type | Description | | ||
| -------- | --------------------------------------------------------------------- | | ||
| feat | Declares a new feature has been added | | ||
| fix | Declares a bug have been fixed | | ||
| chore | Declares changes which don’t modify source or test files (eg. assets) | | ||
| ci | Declares a change on the CI or CD process | | ||
| build | Declares changes on the build setup | | ||
| docs | Declares changes on documentation | | ||
| style | Declares changes on code style | | ||
| refactor | Declares a change of code without an effective change on the program | | ||
| perf | Declares a change on performance | | ||
| revert | Declares that a previous commit has been reverted | | ||
| test | Declares changes on tests | | ||
|
||
### Examples | ||
|
||
#### Commit Message | ||
|
||
``` | ||
refactor: adjust vehicle texture size [#ISSUENUMBER] | ||
refactor: adjust vehicle texture size [NOISSUE] | ||
``` | ||
|
||
#### Branch Name | ||
|
||
``` | ||
refactor/#ISSUENUMBER_adjust-vehicle-texture-size | ||
refactor/NOISSUE_adjust-vehicle-texture-size | ||
``` | ||
|
||
## Contributing | ||
|
||
Developers should follow the following guidelines when contributing to the project: | ||
|
||
### 1. Create a new branch | ||
|
||
When starting work on a new feature or bug fix, create a new branch from the `main` branch. The name | ||
of the branch should be descriptive and should include the issue number and a short description of | ||
the feature or bug fix. For example, if you are working on issue #123, the branch name should | ||
be `feat/#123_add-new-feature`. | ||
|
||
### 2. Commit changes | ||
|
||
When committing changes to the codebase, developers should follow | ||
the [Conventional Commits](#conventional-commits) standard. This will ensure that the commit | ||
messages are consistent and descriptive, and will allow the commit history to be automatically | ||
parsed to generate release notes. | ||
|
||
### 3. Create a draft pull request | ||
|
||
After committing changes to the codebase, create a draft pull request to inform other developers | ||
that you are working on a new feature or bug fix. The pull request should be kept in draft mode | ||
until the feature or bug fix is complete. | ||
|
||
### 4. Create a pull request | ||
|
||
When the feature or bug fix is complete, mark the pull request as ready to review to merge the | ||
changes into the `main` branch. The pull request should be reviewed by at least one other developer | ||
before it can be merged. | ||
|
||
### 5. Review pull request | ||
|
||
When a pull request is marked as ready for review, it should be reviewed by at least one other | ||
developer. The reviewer should verify that the code meets | ||
the [Definition of Done](#definition-of-done). | ||
|
||
### 6. Merge pull request | ||
|
||
Once the pull request has been reviewed and approved, it can be merged into the `main` branch. The | ||
pull request should be merged using the "Rebase and merge" option to ensure that the commit history | ||
remains clean and concise. | ||
|
||
## Definition of Done | ||
|
||
### 1. Code meets coding standards | ||
|
||
All code must adhere to the rules defined in the Clean Code handbook for at least level L1. Level L2 | ||
rules should also be taken into consideration. Specifically, emphasis should be placed on: | ||
|
||
1. Correct abstraction level: The code should have a clear and appropriate level of abstraction, | ||
with well-defined interfaces and separation of concerns. | ||
2. Class diagram: The class diagram should be clear and well-organized, with high cohesion and low | ||
coupling between classes. | ||
3. Correct error handling: The code should handle errors correctly, including validating arguments | ||
and handling exceptions in a consistent and appropriate manner. | ||
|
||
### 2. Unit tests pass | ||
|
||
All code changes must be accompanied by unit tests that verify the expected behavior of the code. | ||
These tests must pass without any errors or failures before the code can be considered complete. | ||
|
||
### 3. Code is reviewed | ||
|
||
All code must be reviewed by at least one other developer to ensure quality and compliance with | ||
coding standards. The code review should focus on identifying any bugs, security vulnerabilities, or | ||
design flaws that could impact the quality or maintainability of the code. | ||
|
||
### 4. Documentation is complete | ||
|
||
All code must be fully documented, including comments within the code and external documentation | ||
such as user manuals. The documentation should be comprehensive and accurate, and should provide | ||
enough detail for other developers and stakeholders to understand the code. | ||
|
||
### 5. Acceptance criteria are met | ||
|
||
The code must meet all of the acceptance criteria as defined by the stakeholders. These acceptance | ||
criteria are used as a basis for verifying that the code meets the intended requirements | ||
|
||
### 6. Security is considered | ||
|
||
The code must be reviewed for security vulnerabilities and any identified issues must be addressed. | ||
The code should be designed with security in mind, and should be subject to regular security testing | ||
to identify any new vulnerabilities. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Copyright © 2023 Boostvolt (Jan). All rights reserved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# iCover | ||
|
||
[![iCover Banner](public/assets/brand/banner.png)](https://icover.vercel.app/) | ||
|
||
Design a captivating and visually appealing cover artwork for your Apple Music playlist to engage listeners and convey the theme or mood of the curated songs. [icover.vercel.app](https://icover.vercel.app) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Reporting Security Issues | ||
|
||
If you believe you have found a security vulnerability in the codebase, we encourage you to let us | ||
know right away. | ||
|
||
We will investigate all legitimate reports and do our best to quickly fix the problem. |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
import type { Metadata } from "next" | ||
import { ThemeProvider } from "@/components/theme-provider" | ||
import "@/styles/globals.css" | ||
|
||
export const metadata: Metadata = { | ||
openGraph: { | ||
title: "iCover", | ||
description: | ||
"Design a captivating and visually appealing cover artwork for your Apple Music playlist to engage listeners and convey the theme or mood of the curated songs.", | ||
url: "https://icover.vercel.app", | ||
siteName: "iCover", | ||
images: [ | ||
{ | ||
url: "/assets/brand/banner.png", | ||
width: 1280, | ||
height: 640, | ||
alt: "iCover Banner", | ||
}, | ||
], | ||
locale: "en_US", | ||
type: "website", | ||
}, | ||
} | ||
|
||
interface RootLayoutProps { | ||
children: React.ReactNode | ||
} | ||
|
||
export default function RootLayout({ children }: RootLayoutProps) { | ||
return ( | ||
<html lang="en" suppressHydrationWarning> | ||
<head /> | ||
<body> | ||
<ThemeProvider attribute="class" defaultTheme="system" enableSystem> | ||
{children} | ||
</ThemeProvider> | ||
</body> | ||
</html> | ||
) | ||
} |
Oops, something went wrong.