feat: Rename

frontendnetwork · Jan 24, 2024 · 0c4bec7 · 0c4bec7
1 parent 5a0871b
commit 0c4bec7
Show file tree

Hide file tree

Showing 11 changed files with 102 additions and 96 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -24,7 +24,7 @@ jobs:
 
     environment: 
       name: Production
-      url: https://api.vegancheck.me
+      url: https://api.veganify.app
 
     steps:
       - name: Checkout repository
@@ -79,7 +79,7 @@ jobs:
 
     environment: 
       name: Staging
-      url: https://staging.api.vegancheck.me
+      url: https://staging.api.veganify.app
 
     steps:
       - name: Checkout repository

diff --git a/LICENSE b/LICENSE
@@ -2,7 +2,7 @@ MIT License
 
 Copyright (c) 2024 Philip Brembeck
 Copyright (c) 2024 FrontEndNet.work 
-Copyright (c) 2024 VeganCheck.me Contributors
+Copyright (c) 2024 Veganify Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/OpenAPI.yaml b/OpenAPI.yaml
@@ -91,21 +91,21 @@ paths:
       tags:
         - Peta
 info:
-  title: VeganCheck API
+  title: Veganify API
   description: API for checking if products and ingredients are vegan
   version: 0.3.1
   contact:
     name: FrontendNetwork
-    url: https://vegancheck.me
-    email: info@vegancheck.me
+    url: https://veganify.app
+    email: info@philip.media
   license:
     name: MIT
     url: https://opensource.org/licenses/MIT
 tags: []
 servers:
-  - url: https://api.vegancheck.me
+  - url: https://api.veganify.app
     description: Production server
-  - url: https://api.staging.vegancheck.me
+  - url: https://api.staging.veganify.app
     description: Staging server
 components:
   schemas:
@@ -138,5 +138,5 @@ components:
         - name
         - grade
 externalDocs:
-  description: VeganCheck.me API Documentation
-  url: https://frontendnet.work/vegancheck-api
+  description: Veganify API Documentation
+  url: https://frontendnet.work/veganify-api
diff --git a/README.md b/README.md
@@ -1,46 +1,52 @@
 <div align="center">
-<img src="https://user-images.githubusercontent.com/4144601/221289921-b5437f01-7b5c-415a-afd5-d49b926a9217.svg" alt="VeganCheck API logo" width="128">
+<img src="https://user-images.githubusercontent.com/4144601/221289921-b5437f01-7b5c-415a-afd5-d49b926a9217.svg" alt="Veganify API logo" width="128">
 
-# VeganCheck.me API (v0.3)
+# Veganify API (v0.5)
 
-The official API powering [VeganCheck.me](https://github.com/frontendnetwork/vegancheck.me).
+The official API powering [Veganify](https://github.com/frontendnetwork/veganify).
 
 <br />
 
 ![postman_dark](https://user-images.githubusercontent.com/4144601/232414583-466b133f-ef98-457b-a478-88f53e2e91cd.png#gh-dark-mode-only)
 ![postman_light](https://user-images.githubusercontent.com/4144601/232414600-76809abb-9ace-4801-8787-e116526da4e1.png#gh-light-mode-only)
+
 </div>
 
-## Documentation 
+## Documentation
 
-Please refer to [VeganCheck.me API Documentation](https://frontendnet.work/vegancheck-api) for a full documentation.
+Please refer to [Veganify API Documentation](https://frontendnet.work/veganify-api) for a full documentation.
 
-To learn more about this repo, head to: [https://frontendnetwork.github.io/VeganCheck.me-API/](https://frontendnetwork.github.io/VeganCheck.me-API/).
+To learn more about this repo, head to: [https://frontendnetwork.github.io/Veganify-API/](https://frontendnetwork.github.io/Veganify-API/).
 
 There is an official [Wrapper for React available on npm](https://www.npmjs.com/package/@frontendnetwork/vegancheck).
 
 ### Swagger
-[![Validate OpenAPI.yml](https://github.com/frontendnetwork/VeganCheck.me-API/actions/workflows/validate.yml/badge.svg)](https://github.com/JokeNetwork/VeganCheck.me-API/actions/workflows/validate.yml)
 
-The [`OpenAPI.yml`](https://github.com/frontendnetwork/VeganCheck.me-API/blob/main/OpenAPI.yaml) is automatically available in [this Swagger UI](https://staging.api.vegancheck.me/api-docs).
+[![Validate OpenAPI.yml](https://github.com/frontendnetwork/veganify-API/actions/workflows/validate.yml/badge.svg)](https://github.com/JokeNetwork/Veganify-API/actions/workflows/validate.yml)
+
+The [`OpenAPI.yml`](https://github.com/frontendnetwork/Veganify-API/blob/main/OpenAPI.yaml) is automatically available in [this Swagger UI](https://staging.api.veganify.app/api-docs).
 
 ### Postman
 
-Postman Collection is available for download here: [VeganCheck API.postman_collection.json.zip](https://github.com/frontendnetwork/VeganCheck.me-API/files/11247406/VeganCheck.API.postman_collection.json.zip)
+Postman Collection is available for download here: [Veganify API.postman_collection.json.zip](https://github.com/frontendnetwork/Veganify-API/files/11247406/VeganCheck.API.postman_collection.json.zip)
 
 ### API Endpoints
 
 > **Warning** <br />
-> All endpoints are only accessible via HTTPS. All HTTP requests will be rerouted to HTTPS.<br /> 
+> All endpoints are only accessible via HTTPS. All HTTP requests will be rerouted to HTTPS.<br />
 > Making a request over HTTP may cause data to be transmitted unencrypted for a short time and the server to send a `301` code.
-    
+
 #### Available endpoints
-The following endpoints are available within the VeganCheck.me API:
-- POST: <https://api.vegancheck.me/v0/product/{barcode}>
-- GET: <https://api.vegancheck.me/v0/ingredients/{ingredientslist}>
-- GET: <https://api.vegancheck.me/v0/peta/crueltyfree>
+
+The following endpoints are available within the Veganify API:
+
+- POST: <https://api.veganify.app/v0/product/{barcode}>
+- GET: <https://api.veganify.app/v0/ingredients/{ingredientslist}>
+- GET: <https://api.veganify.app/v0/peta/crueltyfree>
 
 #### Unavailable endpoints
-The following endpoints are currently unavailable within the public VeganCheck.me API. They're not on the roadmap and will not be published:
-- <del>GET: [https://api.vegancheck.me/v0/peta/veganapproved](https://api.vegancheck.me/v0/peta/veganapproved)</del>
-- <del>POST: <https://api.vegancheck.me/v0/grades/backend></del>
+
+The following endpoints are currently unavailable within the public Veganify API. They're not on the roadmap and will not be published:
+
+- <del>GET: [https://api.veganify.app/v0/peta/veganapproved](https://api.veganify.ap/v0/peta/veganapproved)</del>
+- <del>POST: <https://api.veganify.app/v0/grades/backend></del>
diff --git a/SECURITY.md b/SECURITY.md
@@ -1,24 +1,24 @@
 # Security Policy
 
 > [!IMPORTANT]  
-> Up-to-Date contact information can be found in our [security.txt](https://vegancheck.me/.well-known/security.txt)! 
+> Up-to-Date contact information can be found in our [security.txt](https://veganify.app/.well-known/security.txt)! 
 
 
 ## Supported Versions
 
-Only the current released versions and the versions available online (on https://vegancheck.me) are supported officially. Forks are not within our scope.
+Only the current released versions and the versions available online (on https://veganify.app) are supported officially. Forks are not within our scope.
 
 ## Scope of the Security Policy
 The Scope of this Security Policy includes:
-- analytics.vegancheck.me
-- api.vegancheck.me
-- dev.vegancheck.me *
-- grade.vegancheck.me
-- grades.vegancheck.me
-- mastobot.vegancheck.me †
-- preprod.vegancheck.me *
-- staging.vegancheck.me
-- vegancheck.me
+- analytics.veganify.app
+- api.veganify.app
+- dev.veganify.app *
+- grade.veganify.app
+- grades.veganify.app
+- mastobot.veganify.app †
+- preprod.veganify.app *
+- staging.veganify.app
+- veganify.app
 
 
 > [!NOTE]  
@@ -29,4 +29,4 @@ The Scope of this Security Policy includes:
 
 ## Reporting a Vulnerability
 
-You can read more about reporting a vulnerability [here](https://security.philip.media/vdp). Please also see our contact details in our [security.txt](https://vegancheck.me/.well-known/security.txt).
+You can read more about reporting a vulnerability [here](https://security.philip.media/vdp). Please also see our contact details in our [security.txt](https://veganify.app/.well-known/security.txt).
diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
     <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta charset="utf-8" />
-    <title>VeganCheck.me API Overview</title>
+    <title>Veganify API Overview</title>
     <link
       rel="stylesheet"
       href="https://unpkg.com/@primer/css@^20.2.4/dist/primer.css"
@@ -44,11 +44,11 @@
       </span>
       <img
         width="80px"
-        src="https://raw.githubusercontent.com/JokeNetwork/vegancheck.me/main/public/img/hero_icon.png"
+        src="https://raw.githubusercontent.com/JokeNetwork/veganify.app/main/public/img/hero_icon.png"
         align="right"
-        alt="VeganCheck Logo"
+        alt="Veganify Logo"
       />
-      <h1>VeganCheck.me API Overview</h1>
+      <h1>Veganify API Overview</h1>
       <p>
         <span class="Label mr-1 Label--success">Stable</span
         ><span class="Label mr-1 Label--primary">v0.3.1</span
@@ -102,7 +102,7 @@ <h2>OpenAPI specification</h2>
               </div>
             </div>
             <a
-              href="https://github.com/JokeNetwork/VeganCheck.me-API/blob/main/OpenAPI.yaml"
+              href="https://github.com/JokeNetwork/Veganify-API/blob/main/OpenAPI.yaml"
               class="btn btn-primary"
               >Open in repo</a
             >
@@ -215,21 +215,21 @@ <h2>OpenAPI specification</h2>
                 tags:
                   - Peta
           info:
-            title: VeganCheck API
+            title: Veganify API
             description: API for checking if products and ingredients are vegan
             version: 0.3.1
             contact:
               name: FrontendNetwork
-              url: https://vegancheck.me
-              email: info@vegancheck.me
+              url: https://veganify.app
+              email: info@philip.media
             license:
               name: MIT
               url: https://opensource.org/licenses/MIT
           tags: []
           servers:
-            - url: https://api.vegancheck.me
+            - url: https://api.veganify.app
               description: Production server
-            - url: https://api.staging.vegancheck.me
+            - url: https://api.staging.veganify.app
               description: Staging server
           components:
             schemas:
@@ -262,8 +262,8 @@ <h2>OpenAPI specification</h2>
                   - name
                   - grade
           externalDocs:
-            description: VeganCheck.me API Documentation
-            url: https://frontendnet.work/vegancheck-api
+            description: Veganify API Documentation
+            url: https://frontendnet.work/veganify-api
           </code></pre>
       </div>
 
@@ -285,32 +285,32 @@ <h2>Endpoints</h2>
         All endpoints are only accessible via HTTPS.
       </div>
       <h3>Available endpoints</h3>
-      <p>The following endpoints are available within the VeganCheck.me API:</p>
+      <p>The following endpoints are available within the veganify.app API:</p>
       <ul>
         <li>
-          <code>https://api.vegancheck.me/v0/grades/backend</code><br /><strong
+          <code>https://api.veganify.app/v0/grades/backend</code><br /><strong
             >Warning:</strong
           >
           This endpoint is not publicly available in the repo and will not be
           published.
         </li>
         <li>
           <code
-            >https://api.vegancheck.me/v0/ingredients/{ingredientslist}</code
+            >https://api.veganify.app/v0/ingredients/{ingredientslist}</code
           >
         </li>
-        <li><code>https://api.vegancheck.me/v0/peta/crueltyfree</code></li>
-        <li><code>https://api.vegancheck.me/v0/product/{barcode}</code></li>
+        <li><code>https://api.veganify.app/v0/peta/crueltyfree</code></li>
+        <li><code>https://api.veganify.app/v0/product/{barcode}</code></li>
       </ul>
       <h3>Unavailable endpoints</h3>
       <p>
         The following endpoints are currently unavailable within the
-        VeganCheck.me API:
+        veganify.app API:
       </p>
       <ul>
         <li>
           <code style="text-decoration: line-through"
-            >https://api.vegancheck.me/v0/peta/veganapproved</code
+            >https://api.veganify.app/v0/peta/veganapproved</code
           >
         </li>
       </ul>
@@ -320,27 +320,27 @@ <h2>API documentation</h2>
       </p>
       <ul>
         <li>
-          <a href="https://frontendnet.work/vegancheck-api"
-            >VeganCheck.me API at Frontendnetwork</a
+          <a href="https://frontendnet.work/veganify-api"
+            >veganify.app API at Frontendnetwork</a
           >
         </li>
         <li>
-          <a href="https://frontendnet.work/vegancheck-ingredients-api"
-            >VeganCheck.me Ingredients API at Frontendnetwork</a
+          <a href="https://frontendnet.work/veganify-ingredients-api"
+            >veganify.app Ingredients API at Frontendnetwork</a
           >
         </li>
         <li>
-          <a href="https://frontendnet.work/vegancheck-peta-api"
-            >VeganCheck.me PETA API at Frontendnetwork</a
+          <a href="https://frontendnet.work/veganify-peta-api"
+            >veganify.app PETA API at Frontendnetwork</a
           >
         </li>
       </ul>
       <footer class="border-top">
         <p class="color-fg-muted mt-2">
           &copy; <span id="date"></span>
-          <a href="//vegancheck.me">VeganCheck.me</a> - Licensed under
+          <a href="//veganify.app">veganify.app</a> - Licensed under
           <a
-            href="https://github.com/frontendnetwork/vegancheck.me/blob/main/LICENSE"
+            href="https://github.com/frontendnetwork/veganify.app/blob/main/LICENSE"
             >MIT</a
           >
         </p>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "vegancheck-api",
+  "name": "veganify-api",
   "version": "0.3.1",
-  "description": "VeganCheck.me API, with endpoints v0/product/:barcode, v0/peta/crueltyfree and v0/ingredients/:ingredients",
+  "description": "Veganify API, with endpoints v0/product/:barcode, v0/peta/crueltyfree and v0/ingredients/:ingredients",
   "main": "dist/app.js",
   "scripts": {
     "start": "nest start",
@@ -12,7 +12,7 @@
     "lint": "nest lint",
     "get:peta": "node .github/scripts/peta-cron.js"
   },
-  "author": "JokeNetwork, VeganCheck.me Contributors",
+  "author": "JokeNetwork, Veganify Contributors",
   "license": "MIT",
   "dependencies": {
     "@nestjs/axios": "^3.0.1",