SandroMiguel / readme-template

README.md template for my projects

readme-template

README.md template for my projects

Table of Contents

1. Installation
2. Usage
3. NodeJS scripts
4. Development
5. Contributing
6. Questions
7. Changelog
8. License

Installation

Install with npm

npm i some-package

Usage

Run the script

some-command

NodeJS scripts

• start - see Development
• lint - see Lint code
• lint:fix - see Fix linter errors
• format - see Format JavaScript
• format:php - see format-php
• stylelint - see Lint styles
• stylelint:fix - see Lint and fix styles
• test - see JavaScript unit testing
• test:watch - see JavaScript unit testing (watch mode)
• test:phpunit - see PHP unit testing
• e2e - see E2E testing
• build - see Production

Development

Runs the app in the development mode.

Runs webpack and watches for changes.

yarn start

Lint

Lint code

yarn lint

Fix linter errors

yarn lint:fix

Format JavaScript

yarn format

Format PHP

Example - format User.uploadPhoto.php file:

yarn run prettier ./requests/User.uploadPhoto.php --write

Lint styles

yarn stylelint

Lint and fix styles

yarn stylelint:fix

Run tests

JavaScript unit testing

yarn test

JavaScript unit testing (watch for changes)

yarn test:watch

PHP unit testing

yarn test:phpunit

E2E testing

Run tests with UI

yarn e2e

Production

Builds the app for production into the public folder.

yarn build

Utilities

Sync some package

yarn sync:some-package

Contributing

Want to contribute? All contributions are welcome. Please read the contributing guide.

Questions

If you have questions tweet me at @sandro_m_m or open an issue.

Changelog

See CHANGELOG.md

License

This project is licensed under the MIT License - see the LICENSE file for details

**~ sharing is caring ~**