Skip to content

Commit

Permalink
feat: Initial commit: Keploy's website is now open source! 🚀
Browse files Browse the repository at this point in the history
Signed-off-by: Neha Gupta <[email protected]>
  • Loading branch information
nehagup committed Mar 8, 2024
0 parents commit 5577014
Show file tree
Hide file tree
Showing 162 changed files with 16,864 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/License-Apache_2.0-blue.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions .github/slack.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
120 changes: 120 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.


### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### macOS Patch ###
# iCloud generated files
*.icloud


### Windows ###
# Windows thumbnail cache files
Thumbs.db
Thumbs.db:encryptable
ehthumbs.db
ehthumbs_vista.db

# Dump file
*.stackdump

# Folder config file
[Dd]esktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msix
*.msm
*.msp

# Windows shortcuts
*.lnk

# Jetbrains IDEs
.idea/*

node_modules/
dist/

/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env*.local
.env.*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

# contentlayer
.contentlayer

4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# CHANGELOG.md

## [0.1.0] - 2023-07-26
First release
126 changes: 126 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Contributor Code of Conduct for Keploy

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Expected Behavior

The following behaviors are expected and requested of all community members:

* Act authentically and participate actively in the community to help maintain a positive and productive environment.
* Show consideration and respect in all your actions and speech. Avoid any behavior that is demeaning, discriminatory, or harassing.
* Seek collaboration as an initial step instead of conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Report any unsafe situations, distress or violations of the code of conduct to the maintainers through [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA).
* Practice empathy and kindness towards other community members.
* Respect diverse opinions, perspectives, and experiences.
* Give and receive constructive feedback in a gracious manner.
* Take responsibility for your actions and apologize for mistakes. Use them as learning opportunities.
* Prioritize the well-being and success of the community as a whole over individual gain.

Examples of unacceptable behavior include:

* Violence, threats of violence or any language that incites violence towards any individual or group is prohibited.
* Discriminatory jokes and language, such as those based on gender, race, sexual orientation, religion, ability, or any other characteristic, is strictly forbidden.
* Displaying or sharing sexually explicit or violent content is prohibited.
* Any form of harassment, including but not limited to "doxing" (posting or threatening to post other people's personally identifying information) is prohibited.
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
* Publishing any personal information of others without their explicit consent is strictly forbidden.
* Using sexualized language or imagery, or making any sexual advances towards another person is prohibited.
* Harassment, whether it be public or private, will not be tolerated.

## Enforcement Responsibilities

Organizations' maintainers are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

They have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces related to Keploy, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Contact info

* [Slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA)
* [Mail]([email protected])

## Support 🙏

This project needs a ⭐️ from you. Don't forget to leave a star ⭐️

## Happy Contributions !!
115 changes: 115 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Contributing to Keploy

Thank you for your interest in Keploy and for taking the time to contribute to this project. 🙌 Keploy is a project by developers for developers and there are a lot of ways you can contribute.

If you don't know where to start contributing, ask us on our [Slack channel](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA).

## Code of conduct

Contributors are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).

## Prerequisites for the contributors

Contributors should have knowledge of git, go, and markdown for most projects since the project work heavily depends on them.
We encourage Contributors to set up Keploy for local development and play around with the code and tests to get more comfortable with the project.

Sections

- <a name="contributing"> General Contribution Flow</a>
- <a name="#commit-signing">Developer Certificate of Origin</a>
- <a name="contributing-keploy">Keploy Contribution Flow</a>
- <a name="keploy-server">Keploy Server</a>
- <a name="keploy-docs">Keploy Documentation</a>
- <a name="keploy-sdks">Keploy SDK Integration</a>

# <a name="contributing">General Contribution Flow</a>

## Installation

If you wish to contribute, we highly recommend following the guidelines mentioned below.

**1.** Fork [this](https://github.com/keploy/website) repository.

**2.** Clone your forked copy of the project.

```bash
git clone https://github.com/<GITHUB_USERNAME>/website.git
```

**3.** Open your preferred IDE (Integrated Development Environment) such as Visual Studio Code.

**4.** Navigate to the project directory. Open the folder 'website' in your IDE.

**5.** Make changes in source code.

**6.** Save the file and open it in your web browser by simply double-clicking on the file.

**7.** Alternatively, you can also open the file from within the IDE using the "Open in Default Browser" feature or a browser extension like "Live Server" for VSCode.


**8.** Stage your changes and commit.

```
git add .
git commit -s -m "<your_commit_message>"
```

**9.** Push your local commits to the remote repo.

```
git push
```

**10.** Create a [PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)


## <a name="commit-signing">Signing-off on Commits (Developer Certificate of Origin)</a>

To contribute to this project, you must agree to the Developer Certificate of
Origin (DCO) for each commit you make. The DCO is a simple statement that you,
as a contributor, have the legal right to make the contribution.

See the [DCO](https://developercertificate.org) file for the full text of what you must agree to
and how it works [here](https://github.com/probot/dco#how-it-works).
To signify that you agree to the DCO for contributions, you simply add a line to each of your
git commit messages:

```
Signed-off-by: Jane Smith <[email protected]>
```

In most cases, you can add this signoff to your commit automatically with the
`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email
address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:

```
$ commit -s -m “my commit message w/signoff”
```

To ensure all your commits are signed, you may choose to add this alias to your global `.gitconfig`:

_~/.gitconfig_

```
[alias]
amend = commit -s --amend
cm = commit -s -m
commit = commit -s
```

## <a name="contributing-keploy">Keploy Website Contribution Flow</a>

Keploy Website is written in `Html`, `Css` and `JS` (Javascript).

There are many ways in which you can contribute to Keploy Website.

### <a name="keploy-server">Keploy Website</a>

#### Report an Issue
Report all issues through GitHub Issues using the [Issues]https://github.com/keploy/website/issues/new) template.
To help resolve your issue as quickly as possible, give a proper title and provide all the informations.


# Contact

Feel free to join [slack](https://join.slack.com/t/keploy/shared_invite/zt-12rfbvc01-o54cOG0X1G6eVJTuI_orSA) to start a conversation with us.
Loading

0 comments on commit 5577014

Please sign in to comment.