Skip to content

keploy/website

Repository files navigation

Contributor Notice: This repository is now dedicated exclusively to the Keploy API Playground. As part of an ongoing migration, the Keploy Playground will remain in this repository for now, but it will be moved to a new repository in the future.

GSoC Qualification Task: As this playground forms a part of our GSoC qualification tasks, we welcome contributions only for enhancing and maintaining the playground features.

Getting Started

  1. Ensure Node.js 18.x.x is installed on your machine.

  2. Install the ESLint extension for VS Code:

  3. Configure asset prefix for local developement:

    • For local development, comment out the below line to load assets locally.
      • In next.config.js, the assetPrefix ensures proper asset loading from the new landing page.
        assetPrefix: 'https://keploy-websites.vercel.app'
  4. Running the development server:

    • Use one of the following commands based on your package manager:
      npm run dev
      # or
      yarn dev
      # or
      pnpm dev
  5. Run ESLint:

    • To identify and fix linting issues, run:
      npx eslint .
      Make sure to resolve any linting issues before raising a PR.
  6. Access the app:

Note: This template is inspired by the Cruip Tailwind Landing Page Template.

Brand color Palette


This README guide provides an overview of the color palette used in the project, along with their respective purposes and usage.

Color Name Purpose Color Patch Hash Value
Primary Color Primary headings, primary buttons, main elements #FF914D #FF914D
Secondary Color Backgrounds, borders, subtle accents #00163D #00163D
Neutral Colors Backgrounds, borders, subtle accents #F5F5F5
#FFF
#E6E2D4
#F5F5F5
#FFF
#E6E2D4
Accent Colors Success messages, notifications, progress indicators #16704C #16704C
Highlights, icons, creative sections #5F3131 #5F3131
Attention-grabbing elements, notifications, important highlights #EF546B
#D9CD9C
#EF546B
#D9CD9C
Gradient Colors - #F5F5F5
#E35134
#FF914D
#BE2C1B
#6F0A0D
#F5F5F5
#E35134
#FF914D
#BE2C1B
#6F0A0D

This README guide provides a quick reference to the colors in the palette and their intended purposes. Use this guide to ensure consistent usage of colors throughout the project and to maintain a cohesive visual style.

Feel free to discuss and customize the README guide further based on your project requirements and additional details you'd like to include.


Created and maintained with ❤️ by Keploy.io.