Major Revamps to file layout and README

Author: therealbenpai

.github/workflows/bumpsh.yml

@@ -26,7 +26,7 @@ jobs:
         with:
           doc: 'e1e8a461-3b29-4d71-a8fc-010429c9761e'
           token: ${{secrets.BUMP_TOKEN}}
-          file: doc/api-documentation.yml
+          file: documentation/api-documentation.yml
   api-diff:
     if: ${{ github.event_name == 'pull_request' }}
     name: Check API diff on Bump
@@ -39,7 +39,7 @@ jobs:
         with:
           doc: 'e1e8a461-3b29-4d71-a8fc-010429c9761e'
           token: ${{secrets.BUMP_TOKEN}}
-          file: doc/api-documentation.yml
+          file: documentation/api-documentation.yml
           command: diff
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/codeql.yml

@@ -1,81 +1,33 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
 name: "CodeQL"
-
 on:
   push:
     branches: [ "main" ]
   pull_request:
-    # The branches below must be a subset of the branches above
     branches: [ "main" ]
   schedule:
     - cron: '16 20 * * 4'
-
 jobs:
   analyze:
     name: Analyze
-    # Runner size impacts CodeQL analysis time. To learn more, please see:
-    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
-    #   - https://gh.io/supported-runners-and-hardware-resources
-    #   - https://gh.io/using-larger-runners
-    # Consider using larger runners for possible analysis time improvements.
     runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
     timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
     permissions:
       actions: read
       contents: read
       security-events: write
-
     strategy:
       fail-fast: false
       matrix:
         language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
-        # Use only 'java' to analyze code written in Java, Kotlin or both
-        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
     steps:
     - name: Checkout repository
       uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-
-        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-
-    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
-    # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
       uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
-
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v2
       with:

@types/index.d.ts

@@ -3,3 +3,52 @@
 This is the codebase for the official FemDevs homepage. It is built in Node.js using the Express framework.
 Frontend code is writen in Pug.js and TailwindCSS.
 API uses many free APIs provided by [Free APIs](https://free-apis.github.io/).
+
+## How To Run
+First, you need to install [Node.js](https://nodejs.org/) and [npm](https://npmjs.com). Then, you can run the following commands to start the server:
+```bash
+npm i
+npm run build
+node .
+```
+
+The Webpage will be available at `http://localhost:3000`. (Note; CDNs, assets, and APIs are automatically setup to pull from the official server (`SUBDOMAIN.thefemdevs.com`), and therefore will not work regualarly on localhost. You will need to make additional modifications to the code to be able to access said resources locally.)
+
+## List of Tools
+- [Node.js](https://nodejs.org/) => JavaScript runtime
+- [Express](https://expressjs.com/) => Web framework for Node.js
+- [Pug.js](https://pugjs.org/) => Template engine for Node.js
+- [TailwindCSS](https://tailwindcss.com/) => Utility-first CSS framework
+- [PostCSS](https://postcss.org/) => A tool for transforming CSS with JavaScript
+- [Autoprefixer](https://npmjs.com/package/autoprefixer) => A plugin to parse CSS and add vendor prefixes to CSS rules
+- [Chalk](https://npmjs.com/package/chalk) => Terminal string styling done right
+- [Dotenv](https://npmjs.com/package/dotenv) => A zero-dependency module that loads environment variables from a .env file into process.env
+- [Express-Session](https://npmjs.com/package/express-session) => Create a session middleware
+- [Firebase](https://firebase.google.com/) => A platform developed by Google for creating mobile and web applications
+- [IP Info](https://ipinfo.io/) => A free IP geolocation API
+- [Axios](https://npmjs.com/package/axios) => Promise based HTTP client for the browser and node.js
+- [Postgres](https://www.postgresql.org/) => A powerful, open source object-relational database system
+- [Response Time](https://npmjs.com/package/response-time) => Response time header for Node.js
+- [Stripe](https://stripe.com/) => A suite of payment APIs that powers commerce for online businesses of all sizes
+- [vhost](https://npmjs.com/package/vhost) => Create an HTTP server for each virtual host
+- [Free APIs](https://free-apis.github.io/) => Free APIs for developers
+
+## Contributing
+
+If you would like to contribute to the project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## License
+
+This project is licensed under the Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+## Code of Conduct
+
+Please read the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file for details on our code of conduct.
+
+## Contributors
+
+We have a list of contributors [here](Contributors). If you would like to be added to the list, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## Contact
+
+If you have any questions, please feel free to reach out to us at [[email protected]](mailto:[email protected]).

README.md

@@ -1,9 +1,11 @@
 const router = require('express').Router();
+const RateLimiter = require('../middleware/rateLimit')
 require('dotenv').config();
 
 const mainRoutes = require('./routes/router');
 
 router
+    .use(RateLimiter.main)
     .use('/', mainRoutes);
 
 module.exports = router;

api/index.js

@@ -1,37 +1,21 @@
 const router = require('express').Router();
 
-const fullDataToLocationData = (data) => {
-    const finalObj = {
-        address: {
-            full: '',
-            houseNumber: '',
-            street: '',
-            city: '',
-            region: '',
-            country: '',
-            postalCode: '',
-        },
-        pluscode: '',
-        coords: {
-            lat: '',
-            lng: '',
-        },
+const fullDataToLocationData = (data) => Object.assign({ address: { full: '', houseNumber: '', street: '', city: '', region: '', country: '', postalCode: '' }, pluscode: '', coords: { lat: '', lng: '' } }, {
+    address: {
+        full: data.results[0].formatted_address,
+        houseNumber: (data.results[0].address_components).filter(a => a.types.includes('street_number'))[0]?.long_name,
+        street: (data.results[0].address_components).filter(a => a.types.includes('route'))[0]?.long_name,
+        city: (data.results[0].address_components).filter(a => a.types.includes('locality'))[0].long_name,
+        region: (data.results[0].address_components).filter(a => a.types.includes('administrative_area_level_1'))[0].long_name,
+        country: (data.results[0].address_components).filter(a => a.types.includes('country'))[0].long_name,
+        postalCode: (data.results[0].address_components).filter(a => a.types.includes('postal_code'))[0].long_name,
+    },
+    pluscode: (data?.plus_code)?.global_code,
+    coords: {
+        lat: (data.results[0].geometry).location.lat,
+        lng: (data.results[0].geometry).location.lng,
     }
-    const address = data.results[0].address_components
-    const geometry = data.results[0].geometry
-    const pluscode = data?.plus_code
-    finalObj.address.full = data.results[0].formatted_address
-    finalObj.address.houseNumber = address.filter(a => a.types.includes('street_number'))[0]?.long_name
-    finalObj.address.street = address.filter(a => a.types.includes('route'))[0]?.long_name
-    finalObj.address.city = address.filter(a => a.types.includes('locality'))[0].long_name
-    finalObj.address.region = address.filter(a => a.types.includes('administrative_area_level_1'))[0].long_name
-    finalObj.address.country = address.filter(a => a.types.includes('country'))[0].long_name
-    finalObj.address.postalCode = address.filter(a => a.types.includes('postal_code'))[0].long_name
-    finalObj.pluscode = pluscode?.global_code
-    finalObj.coords.lat = geometry.location.lat
-    finalObj.coords.lng = geometry.location.lng
-    return finalObj;
-}
+});
 
 router
     .get('/coords', async (req, res) => {
@@ -46,7 +30,7 @@ router
         })
         const data = JSON.parse(results.data)
         if (data.status == 'ZERO_RESULTS') return res.sendError(13)
-        res.json({data: fullDataToLocationData(data)});
+        res.json({ data: fullDataToLocationData(data) });
     })
     .get('/pluscode', async (req, res) => {
         const pluscode = req.headers['x-pluscode']
@@ -60,7 +44,7 @@ router
         })
         const data = JSON.parse(results.data)
         if (data.status == 'ZERO_RESULTS') return res.sendError(13)
-        res.json({data: fullDataToLocationData(data)});
+        res.json({ data: fullDataToLocationData(data) });
     })
     .get('/address', async (req, res) => {
         const address = req.headers['x-address']
@@ -74,7 +58,7 @@ router
         })
         const data = JSON.parse(results.data)
         if (data.status == 'ZERO_RESULTS') return res.sendError(13)
-        res.json({data: fullDataToLocationData(data)});
+        res.json({ data: fullDataToLocationData(data) });
     })
     .use((req, res, next) => {
         const { path } = req;

api/routes/location.js

@@ -0,0 +1,9 @@
+const router = require('express').Router();
+require('dotenv').config();
+
+const routes = require('./routes/router');
+
+router
+    .use(router)
+
+module.exports = router;

core/index.js

@@ -34,7 +34,7 @@ router
     .get(`/501`, (req, res) => {
         res.render(
             `misc/501.pug`,
-            req.getErrPage(501, { errorId: require(`../functions/util-fuctions`).Utils.Crypto.FullHash("Testing Error") })
+            req.getErrPage(501, { errorId: require(`../../functions/util-fuctions`).Utils.Crypto.FullHash("Testing Error") })
         )
     })
     .get(`/location`, (req, res) => {

routes/ab.js core/routes/ab.js

@@ -2,7 +2,7 @@ const express = require('express')
 const router = express.Router()
 const { default: StripeSDK } = require('stripe')
 const StripeInstance = new StripeSDK('sk_test_51O2gfrBeqjdZxel2weZc8YAOTGvnj15TCZzoFjr1kuM8nzvpAI7lGsXPW1mqamRXTZ3VWoISpdhTRUtC2v29Nf2l00JHlh2VkX')
-const TokenManager = require('../../functions/crypto');
+const TokenManager = require('../../../functions/crypto');
 
 const payment = require('./pay')
 const api = require('./api')

routes/errors.js core/routes/errors.js

@@ -3,12 +3,12 @@ const router = require('express').Router();
 require('dotenv').config();
 
 //- Routes
-const website = require('./main');
-const legal = require('./legal');
-const error = require('./errors');
-const ab = require('./ab');
+const website = require('./routes/main');
+const legal = require('./routes/legal');
+const error = require('./routes/errors');
+const ab = require('./routes/ab');
 const OSSProject = require('../oss/routes/project');
-const Payment = require('./pay/router')
+const Payment = require('./routes/pay/router')
 
 //- Router setup
 router

routes/legal.js core/routes/legal.js

@@ -4,18 +4,11 @@ const cors = require('cors');
 const vhost = require('vhost');
 const crypto = require('crypto');
 const Admin = require('firebase-admin');
-const { RateLimiterMemory } = require('rate-limiter-flexible');
 require('dotenv').config();
 
-const RateLimiter = new RateLimiterMemory({
-    points: 30,
-    duration: 1,
-})
-
 //- Middleware
 const IPM = require('./middleware/IP'); //? IP Middleware
 const SM = require('./middleware/session'); //? Session Manager
-const MRL = require('./middleware/rateLimit')(RateLimiter); //? Rate Limiter
 const TRACE = require('./middleware/traceHandler'); //? Tracing Middleware
 const RL = require('./middleware/routeLogger'); //? Route Logger
 const Headers = require('./middleware/headers'); //? Header Setter
@@ -106,14 +99,7 @@ app
                     ipData.hash === (
                         function (data) {
                             let currentHash = data;
-                            crypto.getHashes().forEach(
-                                hashAlg => {
-                                    currentHash = crypto
-                                        .createHash(hashAlg)
-                                        .update(currentHash)
-                                        .digest('base64url')
-                                }
-                            );
+                            crypto.getHashes().forEach(hashAlg => { currentHash = crypto.createHash(hashAlg).update(currentHash).digest('base64url') });
                             return crypto
                                 .createHash('id-rsassa-pkcs1-v1_5-with-sha3-512')
                                 .update(currentHash)
@@ -134,15 +120,8 @@ app
         next();
     })
     .use(TRACE)
-    .use(MRL)
     .use(Headers)
     .use(cors(CORSPerms))
-    .use(vhost('api.thefemdevs.com', require('./api/')))
-    .use(vhost('oss.thefemdevs.com', require('./oss/')))
-    .use(vhost('cdn.thefemdevs.com', require('./cdn/')))
-    .use(vhost('www.thefemdevs.com', require('./routes/router')))
-    .use(vhost('thefemdevs.com', require('./routes/router')))
-    .use(vhost('localhost', require('./routes/router')))
     .get(`/robots.txt`, (_, res) => {
         res
             .sendFile(`${process.cwd()}/metadata/robots.txt`)
@@ -152,6 +131,12 @@ app
             .setHeader(`Content-Type`, `text/xml`)
             .sendFile(`${process.cwd()}/metadata/sitemap.xml`)
     })
+    .use(vhost('api.thefemdevs.com', require('./api/')))
+    .use(vhost('oss.thefemdevs.com', require('./oss/')))
+    .use(vhost('cdn.thefemdevs.com', require('./cdn/')))
+    .use(vhost('*.thefemdevs.com', require('./core/')))
+    .use(vhost('thefemdevs.com', require('./core/')))
+    .use(vhost('localhost', require('./core/')))
     .use((req, res, next) => {
         const { path } = req;
         const methodUsed = req.method.toUpperCase();