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

Added Pottekkat 'Awesome ReadME Template' #33

Merged
merged 3 commits into from
Apr 15, 2024
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
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# These are supported funding model platforms

github: [ShaanCoding]
patreon: # Replace with a single Patreon username
patreon: shaankhan
open_collective: # Replace with a single Open Collective username
ko_fi: shaankhan
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
Expand Down
92 changes: 46 additions & 46 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
@@ -1,51 +1,51 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages
# # Simple workflow for deploying static content to GitHub Pages
# name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# on:
# # Runs on pushes targeting the default branch
# push:
# branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# # Allows you to run this workflow manually from the Actions tab
# workflow_dispatch:

# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# # Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
# permissions:
# contents: read
# pages: write
# id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
# # Allow one concurrent deployment
# concurrency:
# group: "pages"
# cancel-in-progress: true

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: "npm"
- name: Install dependencies
run: npm install
- name: Build
run: npm run build
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload dist repository
path: "./dist"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
# jobs:
# # Single deploy job since we're just deploying
# deploy:
# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
# runs-on: ubuntu-latest
# steps:
# - name: Checkout
# uses: actions/checkout@v3
# - name: Set up Node
# uses: actions/setup-node@v3
# with:
# node-version: 18
# cache: "npm"
# - name: Install dependencies
# run: npm install
# - name: Build
# run: npm run build
# - name: Setup Pages
# uses: actions/configure-pages@v3
# - name: Upload artifact
# uses: actions/upload-pages-artifact@v1
# with:
# # Upload dist repository
# path: "./dist"
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
}
],
"image": "https://github.com/Fernanda-Kipper/Readme-Templates/raw/main/.github/logo.png",
"dateCreated": "2024-04-14T00:00:00.000Z",
"dateCreated": "2024-04-14T00:00:00.000Z",
"lastUpdated": "2024-04-14T12:00:00.000Z",
"tags": [
{
Expand All @@ -32,9 +32,21 @@
"url": "backend"
}
],
"featured": true,
"folder": "readme-templates-backend",
"startupBlocks": ["projectHeaderMacro", "technologiesMacro", "gettingStartedMacro", "prerequisitesMacro", "cloningMacro", "configEnvironmentVariablesMacro", "startingMacro", "apiEndpointsMacro", "collaboratorsMacro", "contributeMacro", "documentationThatMightHelpMacro"],
"featured": false,
"folder": "fernanda-kipper-readme-templates-backend",
"startupBlocks": [
"projectHeaderMacro",
"technologiesMacro",
"gettingStartedMacro",
"prerequisitesMacro",
"cloningMacro",
"configEnvironmentVariablesMacro",
"startingMacro",
"apiEndpointsMacro",
"collaboratorsMacro",
"contributeMacro",
"documentationThatMightHelpMacro"
],
"functions": [
{
"name": "Header",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
}
],
"image": "https://github.com/Fernanda-Kipper/Readme-Templates/raw/main/.github/logo.png",
"dateCreated": "2024-04-14T00:00:00.000Z",
"dateCreated": "2024-04-14T00:00:00.000Z",
"lastUpdated": "2024-04-14T12:00:00.000Z",
"tags": [
{
Expand All @@ -32,9 +32,20 @@
"url": "frontend"
}
],
"featured": true,
"folder": "readme-templates-frontend",
"startupBlocks": ["projectHeaderMacro", "layoutMacro", "technologiesMacro", "gettingStartedMacro", "prerequisitesMacro", "cloningMacro", "startingMacro", "collaboratorsMacro", "contributeMacro", "documentationThatMightHelpMacro"],
"featured": false,
"folder": "fernanda-kipper-readme-templates-frontend",
"startupBlocks": [
"projectHeaderMacro",
"layoutMacro",
"technologiesMacro",
"gettingStartedMacro",
"prerequisitesMacro",
"cloningMacro",
"startingMacro",
"collaboratorsMacro",
"contributeMacro",
"documentationThatMightHelpMacro"
],
"functions": [
{
"name": "Header",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
}
],
"image": "https://github.com/othneildrew/Best-README-Template/raw/master/images/logo.png",
"dateCreated": "2024-04-13T00:00:00.000Z",
"dateCreated": "2024-04-13T00:00:00.000Z",
"lastUpdated": "2024-04-14T12:00:00.000Z",
"tags": [
{
Expand All @@ -29,8 +29,21 @@
}
],
"featured": true,
"folder": "best-readme-template",
"startupBlocks": ["projectHeaderMacro", "aboutTheProjectMacro", "builtWithMacro", "gettingStartedMacro", "prerequisitesMacro", "installationMacro", "usageMacro", "roadmapMacro", "contributingMacro", "licenseMacro", "contactMacro", "acknowledgmentsMacro"],
"folder": "othneildrew-best-readme-template",
"startupBlocks": [
"projectHeaderMacro",
"aboutTheProjectMacro",
"builtWithMacro",
"gettingStartedMacro",
"prerequisitesMacro",
"installationMacro",
"usageMacro",
"roadmapMacro",
"contributingMacro",
"licenseMacro",
"contactMacro",
"acknowledgmentsMacro"
],
"functions": [
{
"name": "Project Header",
Expand Down Expand Up @@ -213,7 +226,7 @@
{
"label": "Installation Description",
"name": "installationDescription",
"defaultValue": "_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._\n\n1. Get a free API Key at [https:\/\/example.com](https:\/\/example.com)\n2. Clone the repo\n ```sh\n git clone https:\/\/github.com\/your_username_\/Project-Name.git\n ```\n3. Install NPM packages\n ```sh\n npm install\n ```\n4. Enter your API in `config.js`\n ```js\n const API_KEY = \"ENTER YOUR API\";\n ```",
"defaultValue": "_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._\n\n1. Get a free API Key at [https://example.com](https://example.com)\n2. Clone the repo\n ```sh\n git clone https://github.com/your_username_/Project-Name.git\n ```\n3. Install NPM packages\n ```sh\n npm install\n ```\n4. Enter your API in `config.js`\n ```js\n const API_KEY = \"ENTER YOUR API\";\n ```",
"_type": "textArea"
}
]
Expand All @@ -226,7 +239,7 @@
{
"label": "Usage Description",
"name": "usageDescription",
"defaultValue": "Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.\n\n_For more examples, please refer to the [Documentation](https:\/\/example.com)_",
"defaultValue": "Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.\n\n_For more examples, please refer to the [Documentation](https://example.com)_",
"_type": "textArea"
}
]
Expand All @@ -239,7 +252,7 @@
{
"label": "Roadmap Description",
"name": "roadmapDescription",
"defaultValue": "- [x] Add Changelog\n- [x] Add back to top links\n- [ ] Add Additional Templates w\/ Examples\n- [ ] Add \"components\" document to easily copy & paste sections of the readme\n- [ ] Multi-language Support\n - [ ] Chinese\n - [ ] Spanish",
"defaultValue": "- [x] Add Changelog\n- [x] Add back to top links\n- [ ] Add Additional Templates w/ Examples\n- [ ] Add \"components\" document to easily copy & paste sections of the readme\n- [ ] Multi-language Support\n - [ ] Chinese\n - [ ] Spanish",
"_type": "textArea"
},
{
Expand All @@ -258,7 +271,7 @@
{
"label": "Contributing Description",
"name": "contributingDescription",
"defaultValue": "Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature\/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature\/AmazingFeature`)\n5. Open a Pull Request",
"defaultValue": "Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request",
"_type": "textArea"
}
]
Expand Down Expand Up @@ -290,7 +303,7 @@
{
"label": "Contact Description",
"name": "contactDescription",
"defaultValue": "Your Name - [@your_twitter](https:\/\/twitter.com\/your_username) - [email protected]\n\nProject Link: [https:\/\/github.com\/your_username\/repo_name](https:\/\/github.com\/your_username\/repo_name)",
"defaultValue": "Your Name - [@your_twitter](https://twitter.com/your_username) - [email protected]\n\nProject Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name)",
"_type": "textArea"
}
]
Expand Down
Loading