Skip to content

Commit

Permalink
feat: add backend and missing pages with prettier format
Browse files Browse the repository at this point in the history
BREAKING CHANGE: from react and nodejs to nextjs

fix #269
  • Loading branch information
Dun-sin committed Nov 5, 2023
1 parent 92579b3 commit ddf383f
Show file tree
Hide file tree
Showing 85 changed files with 25,667 additions and 23,851 deletions.
6 changes: 3 additions & 3 deletions .github/Dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'

open-pull-requests-limit: 1
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🐛 Bug
description: Report an issue to help improve the project.
title: "[BUG] <what is the issue>"
labels: ["bug", "hacktoberfest"]
title: '[BUG] <what is the issue>'
labels: ['bug', 'hacktoberfest']
body:
- type: textarea
id: description
Expand All @@ -28,8 +28,8 @@ body:
- type: dropdown
id: browser
attributes:
label: "🥦 Browser"
description: "What browser are you using ?"
label: '🥦 Browser'
description: 'What browser are you using ?'
options:
- Google Chrome
- Brave
Expand All @@ -44,25 +44,25 @@ body:
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
label: '👀 Have you checked if this issue has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
label: '🏢 Have you read the Contributing Guidelines?'
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
- label: 'I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)'
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"
- 'Yes I am willing to submit a PR!'

- type: markdown
attributes:
Expand Down
13 changes: 6 additions & 7 deletions .github/ISSUE_TEMPLATE/doc_issue.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 📄 Documentation issue
description: Found an issue in the documentation? You can use this one!
title: "[DOCS] <what do you have to add>"
labels: ["documentation", "hacktoberfest"]
title: '[DOCS] <what do you have to add>'
labels: ['documentation', 'hacktoberfest']
body:
- type: textarea
id: description
Expand All @@ -28,29 +28,28 @@ body:
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
label: '👀 Have you checked if this issue has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
label: '🏢 Have you read the Contributing Guidelines?'
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
- label: 'I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)'
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"
- 'Yes I am willing to submit a PR!'

- type: markdown
attributes:
value: |
Follow me on Twitter [here](https://twitter.com/DunsinWebDev)
Feel free to Join the discord server [here](https://discord.gg/kcFraw3nhz) and check out other cool repositories [here](https://github.com/Dunsin)
17 changes: 6 additions & 11 deletions .github/ISSUE_TEMPLATE/features.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
name: 💡 General Feature Request
description: Have a new idea/feature for this project? Would love to hear it!
title: "[FEATURE] <what do you have to add>"
labels:
[
"feature",
"enhancement",
"hacktoberfest"
]
title: '[FEATURE] <what do you have to add>'
labels: ['feature', 'enhancement', 'hacktoberfest']
body:
- type: textarea
id: description
Expand All @@ -33,25 +28,25 @@ body:
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
label: '👀 Have you checked if this issue has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
label: '🏢 Have you read the Contributing Guidelines?'
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
- label: 'I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)'
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"
- 'Yes I am willing to submit a PR!'

- type: markdown
attributes:
Expand Down
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: "[OTHER]"
labels: ["hacktoberfest"]
title: '[OTHER]'
labels: ['hacktoberfest']
body:
- type: markdown
attributes:
value: "# Other issue"
value: '# Other issue'
- type: textarea
id: issuedescription
attributes:
Expand All @@ -24,25 +24,25 @@ body:
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked if this issue has been raised before?"
label: '👀 Have you checked if this issue has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
label: '🏢 Have you read the Contributing Guidelines?'
options:
- label: "I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)"
- label: 'I have read and understood the rules in the [Contributing Guidelines](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md)'
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"
- 'Yes I am willing to submit a PR!'

- type: markdown
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/config/lock_unlock_issue.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
"🚦 status: awaiting approval":
'🚦 status: awaiting approval':
issues:
comment: >
To reduce notifications, issues are locked until they are valid/approved and to be assigned. In the meantime read the contributing guidelines -> https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md
unlock: true
lock: true

"🏁 status: ready for dev":
'🏁 status: ready for dev':
issues:
comment: >
The issue has been unlocked and is now ready for dev. If you would like to work on this issue, you can comment to have it assigned to you.
Expand Down
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# 👨‍💻 Changes proposed(What did you do ?)

# ✔️ Check List (Check all the applicable boxes)

<!-- Mark all the applicable boxes. To mark the box as done follow the following conventions -->

<!--
Expand All @@ -18,7 +19,7 @@
- [] This PR does not contain plagiarized content.
- [] The title and description of the PR is clear and explains the approach.

## Note to reviewers
## Note to reviewers

<!-- Add notes to reviewers if applicable -->

Expand Down
9 changes: 4 additions & 5 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
name: deploy website
on:
pull_request_target:
branches:
- main
types:
- closed

branches:
- main
types:
- closed

jobs:
deploy:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/unlock-lock-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

permissions:
issues: write

jobs:
action:
runs-on: ubuntu-latest
Expand Down
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
11 changes: 11 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": true,
"singleQuote": true,
"jsxSingleQuote": true,
"printWidth": 80,
"arrowParens": "avoid",
"endOfLine": "lf",
"bracketSameLine": false
}
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
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,21 @@
- [How to contribute](#-how-to-contribute)

## Guidelines

### Issues guidelines

- Don't work on anything unless you are assigned, if you make a pull request without being assigned to that issue, it will be closed without being merged
- Don't work on more than one issue at a time, this is so that you don't make a huge pull request and others can have opportunities to work on another issue while you work on something else

### Pull Request guidelines

- Don't create a pull request on an issue that doesn't exist, create an issue first and if the changes you are proposing are said to be okay, you can go ahead and create a pull request
- Don't work on the main branch, create your own branch by following the instructions [here](#-how-to-make-a-pull-request)
- If you are working on the backend, share a screenrecording of your working software
- don't create a PR for things outside of your issue's scope, it will lead to more work for the maintainers

### General guidelines

- Do read the `readme.md` file
- If there's no PR for an issue in the allocated time, you will be unassigned, the following labels determine the time. `easy: 4days`, `medium: 7 days(1week)`, `hard: 2 weeks`
- Fill out issue and pull request(PR) templates properly, if you don't know how, check out previous issues/PR to know how they are filled, this video👇🏾 or [this](#-how-to-fill-a-pull-request-templatetext)
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,13 @@ Before installation, please make sure you have already installed the following t

4. Navigate to the respective client and server directory

```bash
cd client
```
```bash
cd client
```

```bash
cd server
```
```bash
cd server
```

5. Install dependencies with `npm install`

Expand All @@ -128,13 +128,13 @@ Before installation, please make sure you have already installed the following t
7. Run npm start in the client directory and npm run dev:docker in the server directory, this uses docker for the server part

```bash
npm start
```
```bash
npm start
```

```bash
npm run dev:docker
```
```bash
npm run dev:docker
```

> For those who do not wish to use Docker, here is another option -> [to start the project](https://github.com/Dun-sin/Whisper/blob/main/CONTRIBUTING.md#starting-the-project-without-docker)
Expand Down
4 changes: 2 additions & 2 deletions next.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** @type {import('next').NextConfig} */
const nextConfig = {
reactStrictMode: true,
}
};

module.exports = nextConfig
module.exports = nextConfig;
Loading

0 comments on commit ddf383f

Please sign in to comment.