gmoraleslondono / retro-calculator Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 1.0 538 KB

🔢 Retro calculator

Home Page: https://retro-calculator.now.sh

License: MIT License

JavaScript 51.93% HTML 48.07%

javascript html css cypress now

retro-calculator's Introduction

Retro Calculator

A colleague challenged me to build a calculator, so I started this project on CodePen to practice JavaScript, CSS, and HTML. When I was almost done a friend found a bug (1 + 1 + 1 = 11) so I quickly made some changes to fix it. I ended up moving the project to GitHub and added some end-to-end tests using Cypress because after my quick fix 1 + 1 = 0 🙈

Prerequisites

Node.js 12.x or newer

Development

How to run locally

Clone this repository.

git clone https://github.com/gmoraleslondono/retro-calculator.git

Run npm install in the repository root.
Run npm start.
Open http://127.0.0.1:8080 🚀

How to Contribute

Please make sure the following is done:

Fork the repository and create your branch from main.
Run npm install in the repository root.
If you’ve fixed a bug or added code that should be tested, add tests!
Ensure the test suite passes (npm test).
Format your code with prettier (npm run prettier).
Make sure your code lints (npm run eslint:check).

Credits

Made with ❤ by Gloria Morales

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Gloria Morales}
💻 📖 🎨 👀

⚠️

_{Tomas Echeverri Valencia}
📖 🐛 💻 🤔 🚇 📆 👀

This project follows the all-contributors specification. Contributions of any kind welcome!

License

retro-calculator's People

Contributors

Watchers

Forkers

fossabot

retro-calculator's Issues

Support different themes

Checklist

iOS
Android
Casio (vintage)
HP-35 (Hewlett-Packard)

Integrate with FOSSA

FOSSA
https://fossa.com/

Context

Continuous dependency tracking
License checks
Vulnerability checks

Requirements

Display FOSSA report at the bottom of the README

Add build status badges

It'd be cool to have a build status section in the README

Examples

gmoraleslondono/todoly's README

🔗 https://github.com/gmoraleslondono/todoly#todoly
sverweij/dependency-cruiser's README

🔗 https://github.com/sverweij/dependency-cruiser#build-status

Add license badge to `README`

Run end-to-end tests on continuous integration server

References

Cypress / Continuous Integration
https://docs.cypress.io/guides/guides/continuous-integration.html
Drastically Simplify Testing on CI with Cypress GitHub Action
https://www.cypress.io/blog/2019/11/20/drastically-simplify-your-testing-with-cypress-github-action/

Checklist

Protect master
Setup CI using GitHub Actions

Add `start` script to `package.json`

Requirements

Use Parcel
https://parceljs.org/
- Adding parcel to your project
  https://parceljs.org/getting_started.html#adding-parcel-to-your-project

Deploy live version

Use ZEIT Now
https://zeit.co/

Add Vue version

Requirements

Use the latest version of Vue
https://vuejs.org/
Use Storybook
https://storybook.js.org/
Make sure it works with existing Cypress tests
cypress/integration/basic-math-operations.spec.js

Use TypeScript

Requirements

Migrate the existing code to TypeScript
Use the latest version of TypeScript
https://www.typescriptlang.org/

Add EditorConfig

References

EditorConfig
https://editorconfig.org/
Visual Studio Code - EditorConfig extension
https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

Checklist

Add EditorConfig extension for VS Code

Coming soon...

Ignore doc changes in GitHub Actions

Requirements

Do not trigger GitHub Actions (e.g. Prettier, ESLint, Cypress, etc) for doc changes

References

Workflow syntax for GitHub Actions / Example ignoring paths

Add License section to README

Requirements

Add "License" section to README
Add link to the license file

Add keyboard support

Requirements

User can use keyboard to input numbers, operation
User can use keyboard to get result
User can use keyboard to clear

Add visual regression tests

Requirements

Add visual testing to existing GitHub workflow to catch visual bugs before they’re released
Use Storybook
https://storybook.js.org/
- Storybook for HTML
  https://storybook.js.org/docs/guides/guide-html/