initial commit

Ysn4Irix · Nov 10, 2023 · 0bc75af · 0bc75af
commit 0bc75af
Show file tree

Hide file tree

Showing 22 changed files with 1,836 additions and 0 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,2 @@
+/node_modules
+.env
diff --git a/.env.example b/.env.example
@@ -0,0 +1,2 @@
+# NODE APP ENVIRONMENT VARIABLES
+NODE_ENV=dev
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,29 @@
+name: release
+
+on:
+    push:
+        tags:
+            - 'v*'
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v2
+
+            - name: Create Source Code Zip
+              run: zip -r source_code.zip .
+              working-directory: ${{ github.workspace }}
+
+            - name: Create Release
+              id: create_release
+              uses: softprops/action-gh-release@v1
+              if: startsWith(github.ref, 'refs/tags/')
+              env:
+                  GITHUB_TOKEN: ${{ github.token }}
+              with:
+                  name: ${{ github.ref_name }}
+                  draft: true
+                  prerelease: false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,72 @@
+# NPM #
+##########
+# Ignore all directories called node_modules in current folder and any subfolders.
+node_modules/
+.env
+# Packages #
+############
+*.7z
+*.dmg
+*.gz
+*.bz2
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+*.tgz
+*.map
+
+# Logs and databases #
+######################
+*.log
+*.sql
+
+# OS generated files #
+######################
+**.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+._*
+**settings.dat*
+
+# Vim generated files #
+######################
+*.un~
+
+# SASS #
+##########
+**/.sass-cache
+**/.sass-cache/*
+**/.map
+
+# Composer #
+##########
+!assets/js/vendor/
+wpcs/
+/vendor/
+
+# Bower #
+##########
+assets/bower_components/*
+
+# Codekit #
+##########
+/codekit-config.json
+*.codekit
+**.codekit-cache/*
+
+# Compiled Files and Build Dirs #
+##########
+/README.html
+
+# PhpStrom Project Files #
+.idea/
+library/vendors/composer
+assets/img/.DS_Store
+
+package-lock.json
+
+# VSCode related files #
+# .vscode
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,9 @@
+{
+	"trailingComma": "none",
+	"arrowParens": "avoid",
+	"singleQuote": true,
+	"printWidth": 80,
+	"useTabs": true,
+	"tabWidth": 4,
+	"semi": false
+}
diff --git a/.vscode/extentions.json b/.vscode/extentions.json
@@ -0,0 +1,3 @@
+{
+	"recommendations": ["esbenp.prettier-vscode"]
+}
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,10 @@
+FROM node:18-alpine
+
+WORKDIR /app
+COPY ./package.json .
+RUN npm install --location=global pnpm
+RUN pnpm install
+COPY . .
+RUN pnpm prune --prod
+EXPOSE 5000
+CMD ["pnpm", "run", "start"]
diff --git a/LICENCE b/LICENCE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Ysn4Irix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,78 @@
+<h2 align="center">
+Github Pinned Repositories API
+</h2>
+
+<br>
+
+<p align="center">
+An API service to get pinned repositories from a Github profile powered by
+</p>
+
+<p align="center">
+  <img width="150px" src="https://res.cloudinary.com/ydevcloud/image/upload/v1658183164/yassi/mgkhs4y9ydmoyjyozulf.svg" align="center" alt="nodejs" />
+  &nbsp; &nbsp; &nbsp;
+  <img width="150px" src="https://res.cloudinary.com/ydevcloud/image/upload/v1662120635/yassi/r923h19buxqfs5ouzzf6.svg" align="center" alt="express" />
+</p>
+<br>
+
+![📟](https://res.cloudinary.com/ydevcloud/image/upload/v1656874185/asm9cp84cbuuqmarw9wq.png)
+
+## Usage
+
+<b style="color:brown;">The number of requests per user is limited to 5 requests per 30 seconds </b>
+
+### Get pinned repositories
+
+```sh
+# with json format
+GET /api/get/?username=ysn4irix
+```
+
+### Response
+
+```json
+{
+  "isError": false,
+  "statusMessage": "OK",
+  "statusCode": 200,
+  "response": [
+    {
+      "name": "madina",
+      "repo": "https://github.com/Ysn4Irix/madina",
+      "description": "Fast API for getting moroccan cities and their districts in json/xml/csv formats.",
+      "demo": "https://madina.ysnirix.xyz/api/alive",
+      "language": {
+        "name": "JavaScript",
+        "color": "#f1e05a"
+      },
+      "stars": 31,
+      "forks": 4
+    },
+    { .... },
+    { .... },
+    { .... },
+    { .... }
+```
+
+<br>
+
+![🙌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/connect.png)
+
+## ❯ About
+
+<summary>
+  <strong>
+    Contributing
+  </strong>
+</summary>
+
+Pull requests and stars are always welcome. For bugs and features requests, [please create an issue](../../issues/new).
+
+<br>
+
+![📃](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/license.png)
+
+## ❯ License
+
+Copyright © 2022-present, [Ysn4Irix](https://github.com/Ysn4Irix).
+Released under the [MIT License](LICENSE).
diff --git a/captain-definition b/captain-definition
@@ -0,0 +1,4 @@
+{
+	"schemaVersion": 2,
+	"dockerfilePath": "./Dockerfile"
+}