Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 1.74 KB
Raw

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Installing Requirements

Requirements

Linux

sudo apt-get install php
sudo apt-get install php-curl
sudo apt-get install composer

Windows

Install PHP from XAMPP or php.net

▶ How to install and run PHP using XAMPP (Windows)

📥 Download Composer

Clone the repository

git clone https://github.com/DenverCoder1/readme-typing-svg.git
cd readme-typing-svg

Running the app locally

composer start

Open http://localhost:8000/ and add parameters to run the project locally.

Running the tests

Before you can run tests, PHPUnit must be installed. You can install it using Composer by running the following command.

composer install

Format and test the code

Run the following command to format the code with Prettier:

composer run format

Run the following command to check if your code is formatted properly:

composer run format:check

Note You need to have prettier and the prettier-php plugin installed globally in order to run this command.

Run the following command to run the PHPUnit test script which will verify that the tested functionality is still working.

composer test