Skip to content

fastredpanda/fun-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 

Repository files navigation

How To Write a Readme Walkthrough

Click To Watch ☝️ - How to write a readme file | The reality of software documentation

README STARTS BELOW THIS

Subscribe Service

Subscribe Service CI

Service provides the ability to subscribe to meroware instance

Also supports enabling notifications

Getting Started

Subscribe service handles the ability to manually subscribe to meroware instance youtube channel through the use of the well written word.

Prerequisites

You will need the following technologies to get the service running

Installing

Go to the root of the folder and running the following

$ Take mouse and click on browser
$ Copy & paste https://www.youtube.com/channel/UCAyEo_24I-oZtsBcAd3Vxig/videos into browser
$ Once in the website, click subscribe

Running Tests

Make sure to run your tests so that it all goes well

Linter

Check your typing skills by making your you properly typed Meroware Instance in the youtube search bar

$ Awesome Meroware Instance videos

Unit Tests

Check to make sure every unit of the service works properly

$ Click mouse multiple times to make sure it works
$ Type multiple letters on the keyboard to make sure it work
$ Check browser can go to website
$ Check that subscribe button is working

Integration Tests

The overall flow of the service needs to be tested so make sure to do the following

$ Go to browser and make sure typing on the search bar works after clicking on the search button

E2E Tests

Alsoways make sure to do end to end testing to make sure it all works properly

$ Tell siri to subscribe you to Meroware Instance youtube channel 

How To Deploy

Make sure to deploy by merging code to master. It will automatically handle everything for you because we are awesome and all our github action pipelines are up to date.

Diagrams

Here is a beautiful diagram depicting the high level diagram of this service

Diagram

Contributing

Contributions are welcomed, always fun to colaborate CONTRIBUTING.md

Code Owners

We have a code owners file that costs all the people that own the code. They will be automatically added to the PRs as approvers.

License

MIT license I guess LICENSE.md

Acknowledgments

  • I give thanks to everyone that has supported this service and that will support it in the future. To you I say thank you.

About

A readme used for youtube readme video

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published