Devops

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Wanderlust - GSSoC Contributors Code of Conduct
+
+
+## ❌ You'll never get issue assigned
+
+- I want to work on this issue please assign it to me, I'll enhance UI
+
+- \_Create an AI generated issue \_and ask to assign
+
+## ✅ You'll easily get issue assigned
+
+- Hi, I know the fix for this issue, the code is breaking because of the useEffect we have added there, instead of that we need to use UseLayoutEffect, I can fix it within **ETA**: 1day.
+- Hi, I seen a UI enhancement in category section of the website, here goes my sample UX/images <_link>_. And I want to pick this issue
+
+## 💡Prop tip from the Project Admin (Me 😜)
+
+- I am happy to provide you the points you need to reach the leaderboard, I look forward to give more points than needed if required, but the minimum I expect is your genuine interest to solve the issue and contribute.
+- Want GSSoC points? Not the right place for you. Want to learn things and master git place for you, and forget about points you'll get more than expected
+- I'm happy to help anyone who is really concerned in learning, _**but please don't spam 100s of project with your random message**_, Stick to 2-3 projects of your like and work on it.
+- Didn't get any issue to work on? Just join the project's discord in readme. I'll help you find one :)
+- Happy learning. Feel free to connect if you are concerned with learning and growing 😊
+
+---
+
+## For those who have time read below
+
+### Issue Assignment Process
+
+- **Preparation**: Contributors must thoroughly investigate issues before expressing interest.
+- **ETA**: Provide an estimated time of completion for the issue.
+- **Approach**: Describe the planned method or solution to resolve the issue.
+
+### Communication
+
+- **Expression of Interest**: Contributors should demonstrate their understanding and readiness to tackle the issue, rather than simply requesting assignment.
+
+### Restrictions
+
+- **AI-Based Issue Creation**: The use of AI to generate issues is strictly discouraged.
+- **Handling Existing Issues**: Contributors are encouraged to focus on resolving existing issues rather than creating new, unnecessary ones.

.github/CONTRIBUTING.md

@@ -36,15 +36,37 @@ We're committed to maintaining a positive and inclusive community, and your coop
 ## Setting up the Project
 
 To setup the project locally follow the steps:
-
 1. Fork and Star the project.
 2. Clone your forked repository.
 3. Run `npm run installer`.
-4. Set up your MongoDB database:
-   - Open MongoDB Compass and run MongoDB locally at `mongodb://localhost:27017`.
-   - Import sample posts data from `backend/data/sample_posts.json`.
-5. Rename the `.env.sample` file in the backend and frontend folders to `.env`.
-6. Launch the development server with `npm start` in the root directory of the repository.
+4. Set up your databases
+   - Make sure you [install mongodb](https://www.mongodb.com/docs/manual/installation/) and run it on port `27017`
+     - Follow one of the two ways to prefill the sample data in the db
+        <details>
+        <summary>mongoimport</summary>
+
+        ```bash
+        mongoimport --db wanderlust --collection posts --file ./data/sample_posts.json --jsonArray
+        ```
+        </details>
+
+        OR
+
+        <details>
+        <summary>Manual insertion using mongodb compass</summary>
+
+        1. Create `wanderlust` db
+        2. Create a new collection named `posts` in the `wanderlust` db
+        3. Use **ADD DATA** option in the `posts` collection and use the content from `backend/data/sample_posts.json` file
+        </details>
+   - Make sure you [install redis](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/) and run it in `redis://127.0.0.1:6379`
+
+
+5. Set up env variables
+   - ```sh
+     cp backend/.env.sample backend/.env && cp frontend/.env.sample frontend/.env.local
+     ```
+7. Launch the development server with `npm start` in the root directory of the repository.
 
 <a name="request-for-changes-pull-requests"></a>
 
@@ -109,7 +131,6 @@ To contribute to this project, you need to create a fork of the repository and t
 Commit your changes, then push the branch to your fork with `git push -u fork` and open a pull request on [the Wanderlust repository](https://github.com/krishnaacharyaa/wanderlust) following the template provided.
 
 <a name="guidelines-to-follow"></a>
-Sure, let's refine the guidelines while keeping them clear and straightforward:
 
 ## Guidelines for Contributions
 

.github/pr-title-checker-config.json

@@ -0,0 +1,13 @@
+{
+	"LABEL": {
+		"name": "Title needs formatting",
+		"color": "F9D0C4"
+	},
+	"CHECKS": {
+		"regexp": "^(fix|feat|docs|chore|refactor)(-#[0-9]+)?: .+"
+	},
+	"MESSAGES": {
+		"success": "Thank you mate!! The PR title meets project's contributing guidelines.",
+		"failure": "Hey wait!! Have you not still checked our contribution guidelines? Don't tell me!! Okay I'll tell one last time ; For your title to be reviewed the PR title should match the required format. \n\nFor example, it should be like: \"fix-#124: Added responsiveness to the Home page screen.\" \n\nOnce done, just trust in us, we'll reconsider your PR 😉"
+	}
+}

.github/workflows/issue-assigned.yaml

@@ -0,0 +1,25 @@
+name: Issue Assigned Comment
+
+on:
+  issues:
+    types: [assigned]
+
+jobs:
+  comment-on-issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment on the assigned issue
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const issue_number = context.issue.number;
+            const issue_assignee = context.payload.assignee.login;
+            const contributing_guidelines_url = 'https://github.com/krishnaacharyaa/wanderlust/blob/main/.github/CONTRIBUTING.md#guidelines-for-contributions';
+
+            github.rest.issues.createComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: issue_number,
+              body: `Hey @${issue_assignee} 🎉! Thanks for jumping on this issue. Before you dive in, please check out our [contributing guidelines](${contributing_guidelines_url}) to ensure we're all on the same page. Happy coding! 🚀`
+            });

.github/workflows/pr-title-checker.yaml

@@ -0,0 +1,41 @@
+name: 'PR Title Checker'
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+
+permissions:
+  contents: write
+  pull-requests: write
+  repository-projects: write
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Run PR Title Checker
+        id: title-check
+        uses: thehanimo/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          pass_on_octokit_error: false
+          configuration_path: .github/pr-title-checker-config.json
+
+      - name: PR title satisfied
+        if: success()
+        run: |
+          gh issue comment ${{ github.event.pull_request.number }} -R ${{ github.repository }} --body  "Hey @${{ github.actor }}! Thanks for sticking to the guidelines! High five! 🙌🏻"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Close PR if title is invalid
+        if: failure()
+        run: |
+          gh issue comment ${{ github.event.pull_request.number }} -R ${{ github.repository }} --body $'Umm... did someone forget to read the style guide? Fix that PR title and let\'s try again! @${{ github.actor }}\nDon\'t worry, it happens to the best of us! Check out our [contributor guidelines](https://github.com/krishnaacharyaa/wanderlust/blob/main/.github/CONTRIBUTING.md) for more details.'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/validate-pr-template.yml

@@ -0,0 +1,70 @@
+name: Validate PR Template
+
+on:
+  pull_request_target:
+    types: [opened, edited]
+
+jobs:
+  validate-pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Validate PR description
+        id: validate
+        run: |
+          echo "Validating PR template..."
+
+          REQUIRED_SECTIONS=("## Summary" "## Description" "## Images" "## Issue(s) Addressed" "## Prerequisites")
+          INVALID_STRINGS=(
+            "_Briefly describe the purpose of this PR._"
+            "_Explain in detail what this PR is all about. This should include the problem you're solving, the approach taken, and any technical details that reviewers need to know._"
+            "_Include any relevant images or diagrams that can help reviewers visualize the changes, if applicable_"
+            "_Enter the issue number of the bug(s) that this PR fixes_"
+            "Template should be strictly **Closes <issue_number>**"
+            "Example: Closes #1"
+          )
+
+          PR_BODY=$(jq -r .pull_request.body < $GITHUB_EVENT_PATH)
+          echo "$PR_BODY"
+          MISSING_SECTIONS=()
+          for section in "${REQUIRED_SECTIONS[@]}"; do
+            if ! echo "$PR_BODY" | grep -q "$section"; then
+              MISSING_SECTIONS+=("$section")
+            fi
+          done
+
+          FOUND_INVALID_STRINGS=()
+          for invalid in "${INVALID_STRINGS[@]}"; do
+            if echo "$PR_BODY" | grep -q "$invalid"; then
+              FOUND_INVALID_STRINGS+=("$invalid")
+            fi
+          done
+
+          if [ ${#MISSING_SECTIONS[@]} -ne 0 ] || [ ${#FOUND_INVALID_STRINGS[@]} -ne 0 ]; then
+            echo "PR description is missing required sections or contains invalid strings."
+            echo "## Missing Sections:" >> $GITHUB_STEP_SUMMARY
+            printf '%s\n' "${MISSING_SECTIONS[@]}" >> $GITHUB_STEP_SUMMARY
+            echo "## Invalid Strings Found:" >> $GITHUB_STEP_SUMMARY
+            printf '%s\n' "${FOUND_INVALID_STRINGS[@]}" >> $GITHUB_STEP_SUMMARY
+            echo "{result}={failure}" >> $GITHUB_OUTPUT
+          else
+            echo "PR description meets the template requirements."
+            echo "{result}={success}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set PR label based on validation
+        if: ${{ steps.validate.outputs.result == 'failure' }}
+        run: |
+          gh pr edit ${{ github.event.pull_request.number }} --add-label "PR description needs formatting"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Remove PR label if validation passed
+        if: ${{ steps.validate.outputs.result == 'success' }}
+        run: |
+          gh pr edit ${{ github.event.pull_request.number }} --remove-label "PR description needs formatting"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -4,4 +4,5 @@ backend/.env
 backend/node_modules
 /node_modules
 coverage/
-.idea/
+.idea/
+package-lock.json

.husky/commit-msg

@@ -0,0 +1,32 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+commit_msg_file="$1"
+commit_msg=$(cat "$commit_msg_file")
+regex_pattern="^(fix|feat|docs|chore|refactor)(-#[0-9]+)?: .+\$"
+if [[ $commit_msg =~ $regex_pattern ]]; then
+  echo ""
+  echo "Hey, hurrah! Thank you for giving attention and following our community guidelines."
+  echo "We're excited to merge your code into the project!"
+  echo ""
+else
+  echo ""
+  echo "Oops!! It seems like you haven't read our community guidelines yet!!"
+  echo "Commits can be of form:"
+  echo ""
+  echo "<tag>-#<issue number>: <commit message>   # if you have relevant issue"
+  echo "OR"
+  echo "<tag>: <commit message>                   # if you don't have relevant issue"
+  echo ""
+  echo "Examples:"
+  echo "❌ Fixed a bug"
+  echo "✅ fix-#123: Fixed a bug"
+  echo "❌ Updated documentation file"
+  echo "✅ chore: Updated documentation"
+
+  echo ""
+  echo "To know all the available tags and for more details"
+  echo "Kindly refer to \033]8;;https://github.com/krishnaacharyaa/wanderlust/blob/9b11b769bb23150b746296cf9008056633d21921/.github/CONTRIBUTING.md#guidelines-for-contributions\aContributing Guidelines\033]8;;\a."
+  echo ""
+exit 1
+fi

.husky/pre-commit

@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+
+. "$(dirname -- "$0")/_/husky.sh"
+
+cd frontend
+echo [FRONTEND] Running the prettier format for you.
+npx lint-staged
+
+cd ../backend
+echo [BACKEND] Running the prettier format for you
+npx lint-staged