From 8299e8ae23f17b99db17d38d80f83bf8ba18834a Mon Sep 17 00:00:00 2001 From: yash Date: Sat, 17 Feb 2024 03:20:47 +0530 Subject: [PATCH] feat: markdowns --- .github/ISSUE_TEMPLATE/bug_report.yml | 96 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++ .github/ISSUE_TEMPLATE/doc.yml | 39 ++++++++ .../ISSUE_TEMPLATE/enhancement_request.yml | 59 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 41 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++ DEPLOYMENT.md | 23 +++++ DEVELOPMENT.md | 31 ++++++ README.md | 25 +++-- 9 files changed, 330 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/doc.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 DEPLOYMENT.md create mode 100644 DEVELOPMENT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..5666e66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,96 @@ + +name: Bug Report +title: "[Bug] Bug title " +description: Create a report to help us identify any unintended flaws, errors, or faults. +body: + - type: checkboxes + attributes: + label: Before Creating the Bug Report + options: + - label: > + I found a bug, not just asking a question, which should be created in [GitHub Discussions](https://github.com/mdgspace/activity-leaderboard-backend/discussions). + required: true + - label: > + I have searched the [GitHub Issues](https://github.com/mdgspace/activity-leaderboard-backend/issues) and [GitHub Discussions](https://github.com/mdgspace/activity-leaderboard-backend/discussions) of this repository and believe that this is not a duplicate. + required: true + - label: > + I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ. + required: true + + - type: textarea + attributes: + label: Runtime platform environment + description: Describe the runtime platform environment. + placeholder: > + OS: (e.g., "Ubuntu 20.04") + OS: (e.g., "Windows Server 2019") + validations: + required: true + + - type: textarea + attributes: + label: Backend version + description: Describe the Backend version. + placeholder: > + branch: (e.g main) + version: (e.g. 1.0.0) + Git commit id: (e.g. c88b5cfa72e204962929eea105687647146112c6) + validations: + required: true + + - type: textarea + attributes: + label: JDK Version + description: Run or Compiler version. + placeholder: > + Compiler: (e.g., "Oracle JDK 11.0.17") + OS: (e.g., "Ubuntu 20.04") + Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251") + OS (if different from OS compiled on): (e.g., "Windows Server 2019") + validations: + required: false + + - type: textarea + attributes: + label: Describe the Bug + description: Describe what happened. + placeholder: > + A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: Steps to Reproduce + description: Describe the steps to reproduce the bug here. + placeholder: > + If possible, provide a recipe for reproducing the error. + validations: + required: true + + - type: textarea + attributes: + label: What Did You Expect to See? + description: You expect to see result. + placeholder: > + A clear and concise description of what you expected to see. + validations: + required: true + + - type: textarea + attributes: + label: What Did You See Instead? + description: You instead to see result. + placeholder: > + A clear and concise description of what you saw instead. + validations: + required: true + + - type: textarea + attributes: + label: Additional Context + description: Additional context. + placeholder: > + Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8a095cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ + + +blank_issues_enabled: false +contact_links: + - name: Ask Question + url: https://github.com/mdgspace/activity-leaderboard-backend/discussions + about: Please go to GitHub Disccusions to ask questions diff --git a/.github/ISSUE_TEMPLATE/doc.yml b/.github/ISSUE_TEMPLATE/doc.yml new file mode 100644 index 0000000..540229f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc.yml @@ -0,0 +1,39 @@ + +name: Documentation Related +title: "[Doc] Documentation Related " +description: I find some issues related to the documentation. +labels: [ "module/doc" ] +body: + - type: checkboxes + attributes: + label: Search before creation + description: > + Please make sure to search in the [issues](https://github.com/mdgspace/activity-leaderboard-backend/issues) + first to see whether the same issue was reported already. + options: + - label: > + I had searched in the [issues](https://github.com/mdgspace/activity-leaderboard-backend/issues) and found + no similar issues. + required: true + + - type: textarea + attributes: + label: Documentation Related + description: Describe the suggestion about document. + placeholder: > + e.g There is a typo + validations: + required: true + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + This is absolutely not required, but we are happy to guide you in the contribution process + especially if you already have a good understanding of how to implement the fix. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.yml b/.github/ISSUE_TEMPLATE/enhancement_request.yml new file mode 100644 index 0000000..ab04414 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_request.yml @@ -0,0 +1,59 @@ + + +name: Enhancement Request +title: "[Enhancement] Enhancement title" +description: Suggest an enhancement for this project +labels: [ "type/enhancement" ] +body: + - type: checkboxes + attributes: + label: Before Creating the Enhancement Request + description: > + Most of issues should be classified as bug or feature request. An issue should be considered as an enhancement when it proposes improvements to + existing functionality or user experience, without necessarily introducing new features or fixing existing bugs. + options: + - label: > + I have confirmed that this should be classified as an enhancement rather than a bug/feature. + required: true + + - type: textarea + attributes: + label: Summary + placeholder: > + A clear and concise description of the enhancement you would like to see in the project. + validations: + required: true + + - type: textarea + attributes: + label: Motivation + placeholder: > + Explain why you believe this enhancement is necessary, and how it benefits the project and community. + Include any specific use cases that you have in mind. + validations: + required: true + + - type: textarea + attributes: + label: Describe the Solution You'd Like + placeholder: > + Describe the enhancement you propose, detailing the change and implementation steps involved. + If you have multiple solutions, please list them separately. + validations: + required: true + + - type: textarea + attributes: + label: Describe Alternatives You've Considered + placeholder: > + List any alternative enhancements or implementations you have considered, and explain why they may not be as effective or appropriate. + validations: + required: true + + - type: textarea + attributes: + label: Additional Context + placeholder: > + Add any relevant context, screenshots, prototypes, or other supplementary information to help illustrate the enhancement. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..435718e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,41 @@ + +name: Feature Request +title: "[Feature] New feature title" +description: Suggest an idea for this project. +labels: [ "type/new feature" ] +body: + - type: textarea + attributes: + label: Is Your Feature Request Related to a Problem? + description: Please Describe It. + placeholder: > + A clear and concise description of what the problem is. + validations: + required: true + + - type: textarea + attributes: + label: Describe the Solution You'd Like + description: Describe how you solved it. + placeholder: > + A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Describe Alternatives You've Considered + description: Describe your solution + placeholder: > + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + + - type: textarea + attributes: + label: Additional Context + description: Additional context. + placeholder: > + Add any other context about the problem here. + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..96bffa5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ + + +### Which Issue(s) This PR Fixes + + + +Fixes #issue_id + +### Brief Description + + + +### How Did You Test This Change? + + diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md new file mode 100644 index 0000000..5e08480 --- /dev/null +++ b/DEPLOYMENT.md @@ -0,0 +1,23 @@ +# Deployment Guide + +## Prerequisites +- [Git](https://git-scm.com/downloads) +- [Docker](https://docs.docker.com/engine/install/) +- [MultiAvatar api secret Key](https://api.multiavatar.com/) +- [Github OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) + +## Steps + +### Clone the repo +``` + git clone https://github.com/mdgspace/activity-leaderboard.git + + cd activity-leaderboard +``` + +### Create .env using .env.example + +### Run docker-compose +``` +docker compose up -d +``` diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..7fd9222 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,31 @@ +# Deployment Guide + +## Prerequisites +- [Git](https://git-scm.com/downloads) +- [Docker](https://docs.docker.com/engine/install/) +- [nodejs](https://nodejs.org/en/download) +- [MultiAvatar api secret Key](https://api.multiavatar.com/) +- [Github OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) + +## Steps + +### Clone the repo +``` + git clone https://github.com/mdgspace/activity-leaderboard.git + + cd activity-leaderboard +``` + +### Create .env using .env.example + +### Run +1. `npm ci` +2. `npm run prepare` +3. `npm run lint` +4. `npm run prettier` + +### Run appplication + +``` +npm start +``` \ No newline at end of file diff --git a/README.md b/README.md index 9d368cc..788aa04 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ -# Activity Leaderboard +# Activity-leaderboard Frontend -## Setup +### Activity Leader Board is a open source project which can be used to monitor progress in an Organization . -1. `npm ci` -2. `npm run prepare` -3. `npm run lint` -4. `npm run prettier` + + +## Tech Stack + +**Backend:** SpringBoot + +**Frontend:** React + +**Cloud:** AWS + +**Database**: Postgres + +**Caching**: Redis + + +### Activity-leaderboard Backend +[Backend](https://github.com/mdgspace/activity-leaderboard.git) \ No newline at end of file