Merge pull request #2 from huntresslabs/dev

Remove API, fix dev env
huntresslabs · Aug 7, 2024 · 4306aa0 · 4306aa0
2 parents 4e001a3 + 52115ec
commit 4306aa0
Show file tree

Hide file tree

Showing 12 changed files with 53 additions and 81 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,37 @@ When Apps Go Rogue.
 
 This repository documents observed the TTPs associated with OIDC/OAuth 2.0 application attacks.
 
+For more information about this subject, please visit the [Wiki](https://github.com/huntresslabs/rogueapps/wiki).
+
 ## Contributing
-If you want to contribue to the RogueApps project, please [open an Issue](https://github.com/huntresslabs/rogueapps/issues/new?assignees=&labels=new+rogueapp&projects=&template=custom.md&title=%5BNew+RogueApp%5D%3A+%28RogueApp+Name%29) Please follow the issue template and include details about the observed TTPs for the RogueApp. Please do not submit any sensitive, private, or proprietary information.
+If you want to contribue to the RogueApps project, please review the [Wiki Contribution Guide](https://github.com/huntresslabs/rogueapps/wiki/Contribution-Guide) and [open an Issue](https://github.com/huntresslabs/rogueapps/issues/new?assignees=&labels=new+rogueapp&projects=&template=custom.md&title=%5BNew+RogueApp%5D%3A+%28RogueApp+Name%29). Please follow the issue template and include details about the observed TTPs for the RogueApp. Please do not submit any sensitive, private, or proprietary information.
 
 ## Adding Contributions
-When a contribution is accepted into the repo, add the details of the contribution to the `rogueapps.json` file located in `public/`. The JSON entries are dynamically queried by the API and the entry cards are then rendered to the Home page.
+When a contribution is accepted into the repo, add the details of the contribution to the `rogueapps.json` file located in `public/`. The JSON entries are dynamically queried by the API and the entry cards are then rendered to the Home page.
+
+## Development Guide
+### Dev Install
+
+First, clone the repository (main or dev branch).
+
+Next, change directories into the repo and installl the Node modules:
+
+```
+npm install
+```
+
+Now, start the dev server:
+```
+npm run dev
+```
+```
+> [email protected] dev
+> next dev
+
+  ▲ Next.js 14.2.5
+  - Local:        http://localhost:3000
+```
+The dev server is now live at `localhost:3000`.
+
+
+
diff --git a/app/about/page.tsx b/app/about/page.tsx
@@ -1,7 +1,13 @@
-import styles from './page.module.css';
+import styles from '../../styles/About.module.css';
 
 export const metadata = {
-  title: 'About - RogueApps',
+  title: 'About RogueApps',
+  description: 'Learn more about RogueApps.',
+  viewport: {
+    width: 'device-width',
+    initialScale: 1,
+  },
+  themeColor: '#00f49c',
 };
 
 export default function About() {

diff --git a/app/contribute/page.tsx b/app/contribute/page.tsx
@@ -1,7 +1,7 @@
 "use client";
 
 import { useState, useEffect } from 'react';
-import styles from './page.module.css';
+import styles from '../../styles/Contribute.module.css';
 
 interface RogueApp {
   contributor: string;

diff --git a/app/layout.tsx b/app/layout.tsx
@@ -1,12 +1,14 @@
-import '../styles/globals.css';
-import Head from 'next/head';
 import Footer from './components/Footer';
 import Navbar from './components/Navbar';
+import '../styles/globals.css';
 
 export const metadata = {
   title: 'RogueApps',
   description: 'RogueApps: when good OAuth apps go rogue.',
-  viewport: 'width=device-width, initial-scale=1',
+  viewport: {
+    width: 'device-width',
+    initialScale: 1,
+  },
   keywords: 'OAuth, security, rogue apps, Huntress',
   robots: 'index, follow',
   themeColor: '#00f49c',
@@ -35,37 +37,11 @@ export const metadata = {
 export default function RootLayout({ children }: { children: React.ReactNode }) {
   return (
     <html lang="en">
-      <Head>
-        <title>{metadata.title}</title>
-        <meta name="description" content={metadata.description} />
-        <meta name="viewport" content={metadata.viewport} />
-        <meta name="keywords" content={metadata.keywords} />
-        <meta name="robots" content={metadata.robots} />
-        <meta name="theme-color" content={metadata.themeColor} />
-        <link rel="icon" href={metadata.icons.icon} />
-        <meta property="og:title" content={metadata.openGraph.title} />
-        <meta property="og:description" content={metadata.openGraph.description} />
-        <meta property="og:type" content={metadata.openGraph.type} />
-        <meta property="og:url" content={metadata.openGraph.url} />
-        <meta property="og:image" content={metadata.openGraph.image} />
-        <meta property="og:site_name" content={metadata.openGraph.siteName} />
-        <meta property="og:locale" content={metadata.openGraph.locale} />
-        <meta name="twitter:card" content={metadata.twitter.card} />
-        <meta name="twitter:title" content={metadata.twitter.title} />
-        <meta name="twitter:description" content={metadata.twitter.description} />
-        <meta name="twitter:image" content={metadata.twitter.image} />
-        <meta name="twitter:site" content={metadata.twitter.site} />
-        <meta name="twitter:creator" content={metadata.twitter.creator} />
-        <meta name="apple-mobile-web-app-capable" content="yes" />
-        <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
-      </Head>
       <body>
         <Navbar />
-        <div style={{ paddingTop: '5rem' }}>{/* To account for the fixed navbar height */}</div>
         {children}
         <Footer />
       </body>
     </html>
   );
 }
-
diff --git a/lib/getRogueApps.ts b/lib/getRogueApps.ts
@@ -6,4 +6,4 @@ export function getRogueApps() {
   const jsonData = fs.readFileSync(filePath, 'utf8');
   const rogueApps = JSON.parse(jsonData);
   return rogueApps;
-}
+}
diff --git a/next-env.d.ts b/next-env.d.ts
@@ -1,6 +1,5 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
-/// <reference types="next/navigation-types/compat/navigation" />
 
 // NOTE: This file should not be edited
 // see https://nextjs.org/docs/basic-features/typescript for more information.
diff --git a/next.config.js b/next.config.js
@@ -1,8 +1,8 @@
 /** @type {import('next').NextConfig} */
 const nextConfig = {
-    basePath: "/rogueapps",
-    output: "export",  // <=== enables static exports
-    reactStrictMode: true,
-  };
-  
-  module.exports = nextConfig;
+  basePath: process.env.NODE_ENV === 'production' ? '/rogueapps' : '',
+  output: 'export',  // Enables static exports
+  reactStrictMode: true,
+};
+
+module.exports = nextConfig;
diff --git a/package.json b/package.json
@@ -4,8 +4,7 @@
   "private": true,
   "scripts": {
     "dev": "next dev",
-    "build": "next build",
-    "deploy": "next build && gh-pages -d out"
+    "build": "next build"
   },
   "dependencies": {
     "next": "14.2.5",
@@ -18,7 +17,6 @@
     "@types/react-dom": "^18",
     "eslint": "^8",
     "eslint-config-next": "14.2.5",
-    "gh-pages": "^6.1.1",
     "typescript": "^5"
   }
 }
diff --git a/pages/_document.tsx b/pages/_document.tsx
diff --git a/pages/api/rogueapps.ts b/pages/api/rogueapps.ts
diff --git a/app/about/page.module.css → styles/About.module.css b/app/about/page.module.css → styles/About.module.css
diff --git a/app/contribute/page.module.css → styles/Contribute.module.css b/app/contribute/page.module.css → styles/Contribute.module.css