feat: docker setup and documentations (#1034)

* feat: add to cart api added (#938) * API ADDED * API ADDED * API ADDED * [ImgBot] Optimize images (#1012) *Total -- 554.68kb -> 429.64kb (22.54%) /src/assets/pictures/authpages/Auth_banner.png -- 199.40kb -> 78.36kb (60.7%) /src/assets/pictures/authpages/google.png -- 7.87kb -> 4.75kb (39.68%) /src/assets/pictures/shop/handmades/handmades/h4.png -- 109.57kb -> 109.17kb (0.37%) /src/assets/pictures/shop/handmades/h4.png -- 109.57kb -> 109.17kb (0.37%) /src/assets/pictures/shop/trendingproducts/art/artproduct4.png -- 128.27kb -> 128.21kb (0.05%) Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com> Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com> * feat: added org invites * fix: changing labels * chore(workflows): re-vamped the existing workflows * chore(deps): bump dotenv from 16.0.3 to 16.3.1 (#1015) Bumps [dotenv](https://github.com/motdotla/dotenv) from 16.0.3 to 16.3.1. - [Changelog](https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md) - [Commits](motdotla/dotenv@v16.0.3...v16.3.1) --- updated-dependencies: - dependency-name: dotenv dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Tamal Das <tamalcodes@gmail.com> * fix: updating labels * feat: re-added templates * chore(deps): bump react-icons from 4.8.0 to 4.10.1 (#1017) Bumps [react-icons](https://github.com/react-icons/react-icons) from 4.8.0 to 4.10.1. - [Release notes](https://github.com/react-icons/react-icons/releases) - [Commits](react-icons/react-icons@v4.8.0...v4.10.1) --- updated-dependencies: - dependency-name: react-icons dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Tamal Das <tamalcodes@gmail.com> --------- Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com> Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com> Co-authored-by: Tamal Das <tamalcodes@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: changes to workflow names for DX * docs: updated docs for better understanding * fix: remove extra gaps * feat: new banner for readme * fix: removing extra images * docs: update readme changes * fix: change branch for releases * docs: changes to workflow description * chore(refactor): changes to dockerfiles and issue automations (#1033) * fix: removed extra invitation issue template --------- Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Harsh Patil <harshpatil2956@gmail.com> Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com> Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
ngoworldcommunity · Aug 15, 2023 · 6995ba0 · 6995ba0
1 parent d926fc7
commit 6995ba0
Show file tree

Hide file tree

Showing 33 changed files with 216 additions and 194 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -52,9 +52,6 @@ body:
         - label: "I am willing to work on this issue (blank for no)."
           required: false
 
-        - label: "I am a GSSoC23 contributor (blank for no)."
-          required: false
-
   - type: markdown
     attributes:
       value: |

diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml
@@ -51,9 +51,6 @@ body:
         - label: "I am willing to work on this issue (blank for no)"
           required: false
 
-        - label: "I am a GSSoC23 contributor (blank for no)."
-          required: false
-
   - type: markdown
     attributes:
       value: |

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -52,9 +52,6 @@ body:
         - label: "I am willing to work on this issue (blank for no)"
           required: false
 
-        - label: "I am a GSSoC23 contributor (blank for no)."
-          required: false
-
   - type: markdown
     attributes:
       value: |

diff --git a/.github/ISSUE_TEMPLATE/invitation.yml b/.github/ISSUE_TEMPLATE/invitation.yml
diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml
@@ -43,9 +43,6 @@ body:
         - label: "I am willing to work on this issue (blank for no)"
           required: false
 
-        - label: "I am a GSSoC23 contributor (blank for no)."
-          required: false
-
   - type: markdown
     attributes:
       value: |

diff --git a/.github/MilanReadmeBanner.png b/.github/MilanReadmeBanner.png
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
diff --git a/.github/workflows/add-labels-to-pr.yml b/.github/workflows/add-labels-to-pr.yml
@@ -1,4 +1,4 @@
-name: PR Triage Labeler
+name: 📢 Add Labels to PRs
 
 on:
   pull_request_target:

diff --git a/.github/workflows/auto-author-assign.yml b/.github/workflows/auto-author-assign.yml
@@ -1,13 +1,13 @@
-name: 'Auto Author Assign'
-
-on:
-  pull_request_target:
-    types: [opened, reopened]
-
-jobs:
-  assign-author:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: toshimaru/auto-author-assign@v1.1.0
-        with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+name: 📢 Add Authors to PRs
+
+on:
+  pull_request_target:
+    types: [opened, reopened]
+
+jobs:
+  assign-author:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: toshimaru/auto-author-assign@v1.1.0
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
@@ -1,4 +1,4 @@
-name: Welcome to MilanCommunity
+name: 🏡 Greet users
 
 on:
   fork:

diff --git a/.github/workflows/invite.yml b/.github/workflows/invite.yml
@@ -1,3 +1,5 @@
+name: 🏡 Invite users
+
 on:
   issues:
     types: [labeled]

diff --git a/.github/workflows/prodtest.yml b/.github/workflows/prodtest.yml
@@ -1,4 +1,4 @@
-name: E2E Tests + Production deploy
+name: 🚀 MAIN -> E2E Tests + Production Deploy (Frontend)
 
 env:
   VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}

diff --git a/.github/workflows/prodtestbeta.yml b/.github/workflows/prodtestbeta.yml
@@ -1,4 +1,4 @@
-name: E2E Tests + Production deploy (BETA)
+name: 🚀 BETA -> E2E Tests + Production Deploy (Frontend)
 
 env:
   VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}

diff --git a/.github/workflows/prtestbeta.yml b/.github/workflows/prtestbeta.yml
@@ -1,4 +1,4 @@
-name: E2E Tests + Preview deploy (BETA)
+name: 👩🏻‍🚀 BETA -> E2E Tests + Preview Deploy (Frontend)
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/prtests.yml b/.github/workflows/prtests.yml
@@ -1,4 +1,4 @@
-name: E2E Tests + Preview deploy
+name: 👩🏻‍🚀 MAIN -> E2E Tests + Preview Deploy (Frontend)
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/prtitle-lint.yml b/.github/workflows/prtitle-lint.yml
@@ -1,4 +1,4 @@
-name: Lint PR title
+name: 📢 Lint PR Titles
 
 on:
   pull_request_target:

diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -4,7 +4,7 @@ on:
   push:
     # branches to consider in the event; optional, defaults to all
     branches:
-      - main
+      - beta
   # pull_request event is required only for autolabeler
   pull_request:
     # Only following types are handled by the action, but one can default to all as well

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,26 @@
+
+<!-- TOC -->
+
+- [Contributing Guidelines](#contributing-guidelines)
+  - [Commits 👮](#commits-)
+      - [Commit Message Format 🔐](#commit-message-format-)
+      - [ESLint \& Prettier ✨](#eslint--prettier-)
+  - [Issues 👮](#issues-)
+      - [Creating an issue 📝](#creating-an-issue-)
+      - [Working on an Issue 🛠️](#working-on-an-issue-️)
+      - [Closing an Issue 📌](#closing-an-issue-)
+  - [Pull requests 👮](#pull-requests-)
+      - [Creating a Pull Request 📝](#creating-a-pull-request-)
+      - [Pull Request Title Format 🔐](#pull-request-title-format-)
+      - [Reviewing a Pull Request 📌](#reviewing-a-pull-request-)
+        - [DOs](#dos)
+        - [DON'Ts](#donts)
+        - [NOTE](#note)
+
+<!-- /TOC -->
+
 # Contributing Guidelines 
-Please go through the documentation at least once before you start contributing. 
+Please go through the documentation at least once before you start contributing as it will help you understand the project, and how we work better.
 
 ## Commits 👮
 
@@ -78,20 +99,25 @@ Available types:
 - `test` : Use this when you are adding tests.
 - `chore` : Use this when you are changing the build process or auxiliary tools and libraries such as documentation generation.
 
+**Examples:**
+
+- `feat: customized icon for plates`
+- `chore(refactor): remove unused dependencies`
+- `fix: updated broken link in the footer`
 
 
 #### Reviewing a Pull Request 📌
 
 We welcome everyone to review Pull Requests, it is a great way to learn and network.
 
 ##### DOs
-- Be kind and respectful, we use inclusive, gender-neutral language (for example they/them instead of guy/man)
+- Be kind and respectful, we use inclusive, gender-neutral language (for example `they/them` instead of `guy/man`)
 - Use inline comments to explain your suggestions
 - Use inline suggestions to propose changes
 ##### DON'Ts
 - Don't be rude, disrespectful or aggressive
 - Do not repeat feedback, this creates more noise than value (check the existing conversation), use GitHub reactions if you agree/disagree with a comment
-- Do not blindly approve pull requests to improve your GitHub contribution graph
+- Do not spam Pull requests/issues.
 
 
 ##### NOTE

diff --git a/Dockerfile b/Dockerfile
@@ -1,15 +1,21 @@
+# Use an official Node.js image as the base image
 FROM node:16-alpine
-WORKDIR '/app'
 
-COPY package.json .
-RUN npm install 
-COPY . .
+# Set the working directory in the container
+WORKDIR /app
 
-CMD ["npm","start"]
+# Copy package.json and package-lock.json to the container
+COPY package*.json ./
+COPY vite.config.js .
 
+# Install project dependencies
+RUN npm install
 
+# Copy the rest of the application code to the container
+COPY . .
 
-# if facing error while building image, paste there two command in terminal.
+# Expose the port that the Vite server will run on
+EXPOSE 3000
 
-# export DOCKER_BUILDKIT=0
-# export COMPOSE_DOCKER_CLI_BUILD=0
+# Start the Vite development server
+CMD ["npm", "run", "dev"]
diff --git a/README.md b/README.md
@@ -1,22 +1,16 @@
-# What is Milan ?
-
-<div align="center">
-
-<img src="https://img.shields.io/github/repo-size/tamalCodes/Milan?style=for-the-badge" />
-    <a href="https://github.com/tamalCodes/Milan/releases">
-        <img src="https://img.shields.io/github/package-json/v/tamalCodes/Milan?style=for-the-badge" /></a>
-    <a href="./LICENSE">
-        <img src="https://img.shields.io/github/license/tamalCodes/Milan?style=for-the-badge" /></a>
-</div>
-<br>
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/MilanCommunity/Milan)](https://github.com/MilanCommunity/Milan/releases) ![GitHub repo size](https://img.shields.io/github/repo-size/MilanCommunity/Milan)
 
-**Connecting Help and Need.**
+# What is Milan ?
 
-We are a hub that aims to connect NGOs, Charities, and users to collaborate and work together for a better tomorrow. We are working hard, to connect HELP and NEED. You can join us as a club/NGO/Charity OR as a User. Post events, join, gather funds, and set up your shop to support yourself.
+Milan is a hub to **connect** NGOs, Charities, and the world to **collaborate** and **build** a better tommorow. Sign up as a organization/user and be a cause for change. Don't forget to drop a star ⭐.
 
 <br/>
 
-![TekHub Banner (1)](https://user-images.githubusercontent.com/72851613/207783151-1d2f19cf-afa4-477b-8823-dcabb86adbf5.png)
+<div  align="center" >
+
+<img alt="Milan Readme Banner" src="https://raw.githubusercontent.com/MilanCommunity/Milan/beta/.github/MilanReadmeBanner.png" width="700px"/>
+
+</div>
 
 <br>
 
@@ -45,21 +39,23 @@ Remember, Good PR makes you a Good contributor !
 
 We at Milan work hard to maintain the structure, and use conventional Pull request titles and commits. Without a proper template for the PR, not following the guidelines and spam might get the pull request closed, or banned.
 
-  ### 🚧 Basic guidelines, setup 
+### 🚧 Setting up the project
+
+Here's a list of all the things you need to set up the project locally. Make sure you follow all the steps to avoid any errors.
 
-  - [Contributing Guidelines](/CONTRIBUTING.md), your PR/issue might be rejected without following these.
-  - [Clone the repo](/rules/CloneSetup.md) properly to avoid any issues.
-  - [Proper API documentation](https://milan-server.onrender.com/docs/) to understand the API endpoints.
+- [Forking + Cloning](/docs/CloneSetup.md)
+- [Setting up the Frontend](/docs/FrontendSetup.md)
+- [Setting up the Backend](/docs/BackendSetup.md)
+- [Setting up with docker](/docs/DockerSetup.md)
 
-  ### 🚧 Code setups
 
-  - [Setting up the Frontend](/rules/FrontendSetup.md)
-  - [Setting up the Backend](/rules/BackendSetup.md)
-  - [Setting up with docker](/rules/DockerSetup.md)
+### 🚧 Contributing guidelines & More
 
-  ### 🚧 Special
+These are must follow guidelines, resources that you need to go though, before contributing to the project. Super important to follow these.
 
-  - [Open to contribute](https://github.com/tamalCodes/Milan/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%A4%A9+status+%3A++Up+for+Grab%22) issues are the issues that are open to contributions, you can work on them.
+- [Contributing Guidelines](/CONTRIBUTING.md) to be followed.
+- [Workflow Overview](/docs/Workflow.md) of our project.
+- [Proper API documentation](https://milan-server.onrender.com/docs/) for developers.
 
 ## License 👮
 

diff --git a/docker-compose.dev.yaml b/docker-compose.dev.yaml
@@ -0,0 +1,16 @@
+version: "3.8"
+
+services:
+  app:
+    restart: always
+    container_name: milan-frontend-container
+    image: milan-frontend
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ./src:/app/src
+    ports:
+      - 3000:3000
+    env_file:
+      - .env
diff --git a/docker-compose.yaml b/docker-compose.yaml