chore: add eslinter, remove duplicate code (#67)

Signed-off-by: Neha Gupta <[email protected]>
keploy · Aug 1, 2024 · af46ade · af46ade
1 parent 96d6e0b
commit af46ade
Show file tree

Hide file tree

Showing 12 changed files with 3,166 additions and 285 deletions.
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -25,8 +25,8 @@ Created and maintained with ❤️ by [Keploy.io](https://keploy.io/).
 
 ### Getting Started
 
-Please make sure you have Node.js 18.x.x installed on your machine.
-
+- Please make sure you have Node.js 18.x.x installed on your machine.
+- Please install the ESLint extension by microsoft - https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
 First, run the development server:
 
 ```bash
@@ -37,5 +37,7 @@ yarn dev
 pnpm dev
 ```
 
+- Run `npx eslint .` to identify the linting issues and fix them before raising the PR. 
+
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 Note: this template is inspired from cruip/tailwind-landing-page-template 
diff --git a/app/(default)/gittogether/layout.tsx b/app/(default)/gittogether/layout.tsx
@@ -3,8 +3,6 @@ import './css/style.css'
 import { Inter, Architects_Daughter } from 'next/font/google'
 
 import Header from '@/components/conf/header'
-import Banner from '@/components/conf/banner'
-import Footer from "@/components/ui/footer";
 
 const inter = Inter({
   subsets: ['latin'],
@@ -18,15 +16,7 @@ const architects_daughter = Architects_Daughter({
   weight: '400',
   display: 'swap'
 })
-
-export const metadata = {
-  title: 'Create Next App',
-  description: 'Generated by create next app',
-}
-
-export default function RootLayout({
-                                     children,
-                                   }: {
+export default function RootLayout({children,}: {
   children: React.ReactNode
 }) {
   return (

diff --git a/app/(default)/webstories/layout.tsx b/app/(default)/webstories/layout.tsx
@@ -1,24 +1,16 @@
 import "./css/styles.css";
 
 import { Inter } from "next/font/google";
-import Header from "@/components/webstories/components/Header";
 const inter = Inter({
   subsets: ["latin"],
 });
 
-export const metadata = {
-  title: "Create Next App",
-  description: "Generated by create next app",
-};
-
-export default function RootLayout({
-  children,
-}: {
+export default function RootLayout({children}: {
   children: React.ReactNode;
 }) {
   return (
     <html lang="en">
-      <title>WebStories</title>
+      <title>WebStories for Software Testing</title>
       <body
         className={` ${inter.className} font-inter antialiased bg-white text-gray-900 tracking-tight`}
       >

diff --git a/app/(default)/webstories/page.tsx b/app/(default)/webstories/page.tsx
@@ -1,7 +1,7 @@
 import React from "react";
 import StoriesCards from "@/components/webstories/StoriesCards";
 import { DataFiles } from "../../../components/utils/data"; // Import Data from data file
-import Header from "@/components/webstories/components/Header";
+import Header from "@/components/ui/header";
 const page = () => {
   const Data = DataFiles.map((item) => ({
     CardImage: item.CardImage,
@@ -17,4 +17,4 @@ const page = () => {
   );
 };
 
-export default page;
+export default page;
diff --git a/app/layout.tsx b/app/layout.tsx
@@ -18,8 +18,8 @@ export interface Metadata {
 
 export const defaultMetadata: Metadata = {
   title: 'Keploy | Open Source Stubs and API Test Generator for Developer',
-  keywords: "API testing, e2e Testing, ai testing, open source ai testing tool, Service Mocking, Dependency Mocking",
-  description: 'Keploy is AI based test case and stubs/mocks generator for e2e testing. 90% test coverage in minutes with open source testing tool',
+  keywords: "Integration testing, e2e Testing, ai testing, Unit Testing, API Testing, open source ai testing tool, Service Mocking, Dependency Mocking",
+  description: 'Keploy is AI based test case and stubs/mocks generator for integration and unit testing. 90% test coverage in minutes with open source testing tool',
   image: "images/logo.svg",
 };
 

diff --git a/components/webstories/Readme.md b/components/webstories/Readme.md
@@ -1 +1,10 @@
-Images should be 500X750 pixels
+Guidelines for webstories
+1. [ ] The front page will be designed as a cover and will be a little clickbait
+2. [ ] The last page will have our website details and a link to a relevant article
+3. [ ] Brand colour and font should be the same across all designs
+4. [ ] Instead of GIFs using MP4 video clips, GIFs slow down the stories
+5. [ ] Just like a normal page, a webstory will have meta tags
+6. [ ] There will be a category of web stories
+7. [ ] Web Stories must be AMP-compliant, test it with the AMP validator tool -> https://validator.ampproject.org/
+8. [ ] The logo should be a 1:1 ratio, 96X96 px preferred
+9. [ ] Images should be 500X750 pixels
diff --git a/components/webstories/components/Header.tsx b/components/webstories/components/Header.tsx
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,19 @@
+// @ts-check
+
+const eslint = require('@eslint/js');
+const tseslint = require('typescript-eslint');
+
+module.exports = tseslint.config({
+        ignores: ["eslint.config.js"]
+    },
+    {
+        languageOptions: {
+            parserOptions: {
+                // sourceType: 'module',
+                project: true,
+            }
+        }},
+    eslint.configs.recommended,
+    ...tseslint.configs.strictTypeChecked,
+    ...tseslint.configs.stylistic,
+);