Skip to content
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

Integration of prettier into the code #258

Merged
merged 7 commits into from
Jun 12, 2023
Merged
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: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🐞 Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
title: '[Bug]: '
labels: ['bug']
body:
- type: markdown
attributes:
Expand All @@ -13,7 +13,7 @@ body:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Add descriptions
value: "I found a BUG 🐞"
value: 'I found a BUG 🐞'
validations:
required: true
- type: textarea
Expand All @@ -22,7 +22,7 @@ body:
label: Add screenshots
description: Add screenshots to see the problems
placeholder: Add screenshots
value: "Add screenshots"
value: 'Add screenshots'
- type: dropdown
id: browsers
attributes:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🔖 Documentation update
description: Improve Documentation
title: "[Docs]: "
labels: ["documentation"]
title: '[Docs]: '
labels: ['documentation']
body:
- type: markdown
attributes:
Expand All @@ -13,7 +13,7 @@ body:
label: what's wrong in the documentation?
description: which things need to add?
placeholder: Add descriptions
value: "We need to add "
value: 'We need to add '
validations:
required: true
- type: textarea
Expand All @@ -22,7 +22,7 @@ body:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: "Add screenshots"
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: ✨ Feature Request
description: Suggest a feature request
title: "[Feat]: "
labels: ["enhancement"]
title: '[Feat]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
Expand All @@ -12,7 +12,7 @@ body:
attributes:
label: What feature?
placeholder: Add descriptions
value: "I have an idea "
value: 'I have an idea '
validations:
required: true
- type: textarea
Expand All @@ -21,7 +21,7 @@ body:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: "Add screenshots"
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/style.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 👯‍♂️ Style Changing Request
description: Suggest a style designs
title: "[style]: "
labels: ["enhancement"]
title: '[style]: '
labels: ['enhancement']
body:
- type: markdown
attributes:
Expand All @@ -12,7 +12,7 @@ body:
attributes:
label: What's the style idea?
placeholder: Add descriptions
value: "We need to improve "
value: 'We need to improve '
validations:
required: true
- type: textarea
Expand All @@ -21,7 +21,7 @@ body:
label: Add screenshots
description: Add screenshots to see the demo
placeholder: Add screenshots
value: "Add screenshots"
value: 'Add screenshots'
- type: checkboxes
id: terms
attributes:
Expand Down
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "daily"
interval: 'daily'
2 changes: 1 addition & 1 deletion .github/workflows/JSONchecker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: JSON check
on:
push:
paths:
- "**.json"
- '**.json'
pull_request:

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/greetings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ jobs:
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
issue-message: "Welcome, @${{ github.actor }}! Your issue is like a spark that ignites innovation. We're thrilled to dive into it and work together to find a solution."
pr-message: "Great job, @${{ github.actor }}! 🎉 Thank you for opening a pull request. Your contribution is valuable and we appreciate your efforts to improve our project."
footer: "Soon the maintainers/owner will review it and provide you with feedback/suggestions."
pr-message: 'Great job, @${{ github.actor }}! 🎉 Thank you for opening a pull request. Your contribution is valuable and we appreciate your efforts to improve our project.'
footer: 'Soon the maintainers/owner will review it and provide you with feedback/suggestions.'
8 changes: 8 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"printWidth": 120,
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "all",
"bracketSpacing": true
}
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ As contributors and maintainers of this project, we pledge to adhere to the foll

We encourage all members of our community to uphold this code of conduct and to help us create a safe, inclusive, and welcoming environment for all. If you witness or experience any behavior that violates this code of conduct, please report it to the project maintainers immediately.

Thank you for your participation in the devFind community.
Thank you for your participation in the devFind community.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ To contribute to devFind, you will need to have Node.js and Git installed on you
Once you have installed these dependencies, you can clone the devFind repository to your local machine by running the following command in your terminal:

git clone https://github.com/devFind-io/devFind.git

## **Install `pnpm`**

To install `pnpm` use this command.
To install `pnpm` use this command.

npm install -g pnpm

## **Install dependencies**
Expand Down
89 changes: 45 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,88 +18,89 @@
> Thank you for your interest in contributing to our open-source project! <br>

## Prerequisites

- A GitHub account
- Git installed on your local development environment
- Node Package Manager (npm) installed on your local development environment
- pnpm installed on your local development environment

## How to Install Git

Git is a version control system that is used to manage the source code of your project.

To install Git, follow these steps:

1. Download and install Git from the [Official Website](https://git-scm.com/downloads)
2. Open the terminal or command prompt on your local development environment
3. Verify the installation of Git by running the following command:
**`git --version`**
3. Verify the installation of Git by running the following command:
**`git --version`**

## How to Install npm
npm (Node Package Manager) is a package manager for JavaScript programming language and is used to manage the packages that are required by your project.

npm (Node Package Manager) is a package manager for JavaScript programming language and is used to manage the packages that are required by your project.

To install npm, follow these steps:

1. Download and install Node.js from the [Official Website](https://nodejs.org/en/download/)
2. Open the terminal or command prompt on your local development environment
3. Verify that npm has been installed by running the command: **`npm -v`**

## How to Install pnpm

To install project dependencies, please make sure you have pnpm installed on your machine. pnpm is another package manager for Node.js, which is used by this project.

To install pnpm, follow these steps:

1. Open the terminal or command prompt on your local development environment.
2. Run the following command: **`npm install -g pnpm`**

Once pnpm is installed, you can navigate to the project directory and run the following command to install the project dependencies: **`pnpm install`**


## Steps to Add Your Profile Data

1. Fork the repository: To create a copy of the repository in your GitHub account, click on the "Fork" button in the top right corner of the project repository page.
2. Clone the forked repository: To clone the repository to your local development environment, open the terminal or command prompt and run the following command:
**`git clone https://github.com/<your-github-username>/<repository-name>.git`**
2. Clone the forked repository: To clone the repository to your local development environment, open the terminal or command prompt and run the following command:
**`git clone https://github.com/<your-github-username>/<repository-name>.git`**

3. Install dependencies: To install the necessary dependencies for the project, navigate to the project directory and run the following command:
**`pnpm install`**
3. Install dependencies: To install the necessary dependencies for the project, navigate to the project directory and run the following command:
**`pnpm install`**
4. Navigate to the **`public/data`** folder in your project directory.
5. Create a new JSON file named **`your_github_username.json`** (replace your_github_username with your actual GitHub username). Open the file you just created.
7. Add the following JSON object, replacing the placeholder values with your own details:

```json
6. Add the following JSON object, replacing the placeholder values with your own details:
```json
{
"name": "Your Name",
"location": "Your Location",
"bio": "Your Bio should be 20-30 words not more then that",
"avatar": "https://github.com/<your-github-username>.png",
"portfolio": "Your Portfolio URL or Github URL",
"skills": ["Your Skill 1", "Your Skill 2", "..."],
"social": {
"GitHub": "https://github.com/<github-username>",
"Twitter": "https://twitter.com/<twitter-username>",
"LinkedIn": "https://www.linkedin.com/in/<linkedin-username>"
}
"name": "Your Name",
"location": "Your Location",
"bio": "Your Bio should be 20-30 words not more then that",
"avatar": "https://github.com/<your-github-username>.png",
"portfolio": "Your Portfolio URL or Github URL",
"skills": ["Your Skill 1", "Your Skill 2", "..."],
"social": {
"GitHub": "https://github.com/<github-username>",
"Twitter": "https://twitter.com/<twitter-username>",
"LinkedIn": "https://www.linkedin.com/in/<linkedin-username>"
}
},
```
8. Save the **`your_github_username.json`** file.
9. Navigate to the **`src`** folder in your project directory. Open the **`ProfilesList.json`** file.
11. Add your JSON filename (your_github_username.json) to the array of filenames in the ProfileList.json file, like this:
```json
[
"filename1.json",
"filename2.json",
"your_github_username.json"
]

```
12. Save the **`ProfileLists.json`** file.
13. Create a new branch: To create a new branch for your profile, run the following command:
**`git checkout -b add-profile`**
9. Add your changed files to the stage by running the following command:
**`git add .`**
10. Commit your changes: To save your changes to the branch, run the following command:
**`git commit -m "add: <your-name>"`**
11. Push to the branch: To push the changes to the remote repository, run the following command:
**`git push origin add-profile`**
12. Create a pull request: To submit your changes to the main repository, create a pull request by clicking on the "Compare & pull request" button on your forked repository page.
13. Wait for review and merge: Wait for the project maintainers to review and merge your changes.
7. Save the **`your_github_username.json`** file.
8. Navigate to the **`src`** folder in your project directory. Open the **`ProfilesList.json`** file.
9. Add your JSON filename (your_github_username.json) to the array of filenames in the ProfileList.json file, like this:

```json
["filename1.json", "filename2.json", "your_github_username.json"]
```

10. Save the **`ProfileLists.json`** file.
11. Create a new branch: To create a new branch for your profile, run the following command:
**`git checkout -b add-profile`**
12. Add your changed files to the stage by running the following command:
**`git add .`**
13. Commit your changes: To save your changes to the branch, run the following command:
**`git commit -m "add: <your-name>"`**
14. Push to the branch: To push the changes to the remote repository, run the following command:
**`git push origin add-profile`**
15. Create a pull request: To submit your changes to the main repository, create a pull request by clicking on the "Compare & pull request" button on your forked repository page.
16. Wait for review and merge: Wait for the project maintainers to review and merge your changes.

Once your changes are merged, your profile data will be added to the project's **`Profile.json`** file and your profile will be displayed on the project's website.

Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject",
"preinstall": "npx only-allow pnpm"
"preinstall": "npx only-allow pnpm",
"prettier": "prettier --write \"**/*\""
},
"eslintConfig": {
"extends": [
Expand All @@ -41,6 +42,7 @@
]
},
"devDependencies": {
"json-loader": "^0.5.7"
"json-loader": "^0.5.7",
"prettier": "^2.8.8"
}
}
Loading