Skip to content

Commit

Permalink
fix: Update README.md (#217)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md
  • Loading branch information
coolusaHD authored Aug 6, 2023
1 parent d9c6a99 commit b40c488
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,22 @@ To start using this template, follow these steps:
- `npm run prettier-check` - Checks the source code for Prettier formatting.
- `npm run prettier-write` - Formats the source code using Prettier.

## GitHub Workflows 💡

### CI (`ci.yml`) 🏗️
This CI (Continuous Integration) YAML file is used to automate the testing and validation process for a Node.js project. It sets up different workflows and jobs to ensure code quality and detect any issues before merging changes into the main branch. You can set the jobs to be required to prevent merging unfinished branches.

### Deploy Infrastructure (`deploy.yml`) 🚀
This YAML file is used for automating the deployment of a frontend application to a production environment using FTP (File Transfer Protocol).
Before using this deployment YAML file, you need the following prerequisites svaed as secrets:
- FTP server address (`FTP_SERVER_ADRESS`)
- FTP username (`FTP_USERNAME`)
- FTP password (`FTP_PASSWORD`)

### Publish Release (`release.yml`) 📦
This YAML file is used for automating the process of publishing a new release for a GitHub repository.
You need to commit with **conventional commits** (See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)) and need a existing release.

## License 🧾

This project is licensed under the [MIT License](LICENSE).
Expand Down

0 comments on commit b40c488

Please sign in to comment.