Skip to content

Commit

Permalink
update readme intro (#336)
Browse files Browse the repository at this point in the history
* add built by cypress team header

* add license section and badge

* add code of conduct

* add note from mainters block

* add built by cypress team svg

* move line break
  • Loading branch information
amirrustam authored May 17, 2020
1 parent f296267 commit 7ab4e54
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 13 deletions.
52 changes: 52 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contributor Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
42 changes: 29 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
<p style='color: #3f51b5' align="center">
<img style='color: #3f51b5' alt="Cypress Real World App Logo" src="./src/svgs/rwa-logo.svg" />
<p align="center">
<img alt="Cypress Real World App Logo" src="./src/svgs/rwa-logo.svg" />
</p>

<p align="center">
<a href="https://cypress.io">
<img width="140" alt="Cypress Logo" src="./src/svgs/built-by-cypress.svg" />
</a>
</p>

<p align="center">
Expand All @@ -24,12 +30,20 @@ A payment application to demonstrate <strong>real-world</strong> usage of <a hre
<img style='width: 70%' alt="Cypress Real World App" src="./public/img/rwa-readme-screenshot.png" />
</p>

> 💬 **Note from maintainers**
>
> This application is purely for demonstration and educational purposes. Its setup and configuration resemble typical real-world applications, but it's not a full-fledge production system. Use this app to learn, experiment, tinker, and practice application testing with Cypress.
>
> Happy Testing
---

## Features

🛠 Built with [React][reactjs], [XState][xstate], [Express][express], [lowdb][lowdb], & [TypeScript][typescript]
🛠 Built with [React][reactjs], [XState][xstate], [Express][express], [lowdb][lowdb], and [TypeScript][typescript]
⚡️ Zero database dependencies
🚀 Full-stack [Express][express]/[React][reactjs] application with real-world features and tests
👮‍♂️ Local Authentication
👮‍♂️ Local Authentication
🔥 Database Seeding with End-to-end Tests
💻 CI/CD + [Cypress Dashboard][cypressdashboard]

Expand All @@ -40,6 +54,7 @@ The Cypress Real-World App (RWA) is a full-stack Express/React application backe
The app is bundled with [example data](./data/database.json) (`data/database.json`) that contains everything you need to start using the app and run tests out-of-the-box.

> 🚩 **Note**
>
> You can login to the app with any of the [example app users](./data/database.json#L2). The default password for all users is `s3cret`.
### Installation
Expand Down Expand Up @@ -80,9 +95,6 @@ yarn cypress:open

- An [empty database seed](./data/empty-seed.json) is provided along with a script (`yarn start:empty`) to view the application without data.

> 🚩 **Note**
> You can login to the app with any of the [example app users](./data/database.json#L2). The default password for all users is `s3cret`.
## Additional NPM Scripts

| Script | Description |
Expand All @@ -106,12 +118,16 @@ To generate a code coverage report:
1. Run `yarn cypress:run --env coverage=true` and wait for the test run to complete.
2. Once the test run is complete, you can view the report at `coverage/index.html`.

<br />
<br />
<br />
<br />
<p style='color: "#3f51b5"' align="center">
<img width="100" style='color: "#3f51b5"' alt="Cypress Logo" src="./src/svgs/cypress-logo.svg" />
## License

[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cypress-io/cypress/blob/master/LICENSE)

This project is licensed under the terms of the [MIT license](/LICENSE).

---

<p align="center">
<img width="100" alt="Cypress Logo" src="./src/svgs/cypress-logo.svg" />
</p>

[reactjs]: https://reactjs.org
Expand Down
Loading

0 comments on commit 7ab4e54

Please sign in to comment.