math_magicians

Math Magicians

“Math magicians” is a website for all fans of mathematics. It is a Single Page App (SPA) that allows users to: Make simple calculations and read a random math-related quote.

screenshot

Live Demo

Check out this project live, click here

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Setup

Clone this repo into your local device by running the following command on your Terminal:

git clone https://github.com/eduardosancho/math_magicians.git

That will create a folder with the project inside it. Navigate into it to access the files.

Also remember to run:

npm install

This will update the dependencies and download necessary files.

Usage

Before you begin testing and experimenting, remember to use the Terminal to create a branch by running: git checkout -b <branch-name>

Alternatively, if you use GitFlow, you can run the following command to create a new branch: git flow feature start <branch-name>

After that you should be ready to go.

Run tests

Before pushing changes to your branch, I would recommend opening this file:

/.github/workflows/linters.yml

install and run stylelint, and eslint

These linters will help you fit your code to this repo’s syntax standard.

Notice on development tests

To keep consistency during the development of the app, we prepared some unit tests for its core functionality. To run these tests, you just need to type npm test in your terminal (After installation using npm install). Tests are configured to run in watch mode so you can keep track of them during the development of the app. If you need to update the snapshots, document the reason properly both in the project and your PR.

Deployment

Once you’re done with your changes, remember to git pull before doing git push. This will update your local copy of the project if someone else made changes to the repo while you worked on your part.

Author

👤 Eduardo Sancho Solano

Contributors

👤 Andrés Felipe Arroyave Naranjo

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

This project is MIT licensed.