diff --git a/README.md b/README.md index 7944c8c..2eed865 100644 --- 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. \ No newline at end of file +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 +``` +``` +> rogueapps@0.1.0 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 index 1275ea6..f542793 100644 --- 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 index 12ca936..0a3fe84 100644 --- 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 index eff7219..7fcecf8 100644 --- 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 ( -
-