https://github.com/keploy/website
Landing Page Website of Keploy
https://github.com/keploy/website
gsoc landing-page mern-stack nextjs tailwindcss testing
Last synced: 9 months ago
JSON representation
Landing Page Website of Keploy
- Host: GitHub
- URL: https://github.com/keploy/website
- Owner: keploy
- License: gpl-3.0
- Created: 2024-03-08T07:06:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:25:57.000Z (about 1 year ago)
- Last Synced: 2024-10-29T13:20:44.713Z (about 1 year ago)
- Topics: gsoc, landing-page, mern-stack, nextjs, tailwindcss, testing
- Language: TypeScript
- Homepage: https://keploy.io/
- Size: 32.2 MB
- Stars: 15
- Watchers: 1
- Forks: 55
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
> 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:
- You can install the [ESLint extension by Microsoft](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
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.
```js
assetPrefix: 'https://keploy-websites.vercel.app'
```
4. **Running the development server**:
- Use one of the following commands based on your package manager:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
5. **Run ESLint**:
- To identify and fix linting issues, run:
```bash
npx eslint .
```
Make sure to resolve any linting issues before raising a PR.
6. **Access the app**:
- Open [http://localhost:3000](http://localhost:3000) in your browser to view the result.
> **Note:** This template is inspired by the [Cruip Tailwind Landing Page Template](https://github.com/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` |
| Secondary Color | Backgrounds, borders, subtle accents |  | `#00163D` |
| Neutral Colors | Backgrounds, borders, subtle accents | 
 | `#F5F5F5`
`#FFF`
`#E6E2D4` |
| Accent Colors | Success messages, notifications, progress indicators |  | `#16704C` |
| | Highlights, icons, creative sections |  | `#5F3131` |
| | Attention-grabbing elements, notifications, important highlights | 
 | `#EF546B`
`#D9CD9C` |
| Gradient Colors | - | 
 | `#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](https://keploy.io/).