Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: put on the readme how to easy to run it #17

Merged
merged 1 commit into from
Oct 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# youtuber-description-links
# Youtuber Description Links

A tool to help Youtubers to manage theirs video links.

This project started on the 4th edition of #umaStackQueNaodomino which we learned how to use [Youtube Data API] with Go. You can check clips and vods at [Twitch.tv](https://www.twitch.tv/lucas_montano)

Previous Editions's Programming Languages

- [Typescript / Javascript with NodeJS (First Edition)](https://github.com/lucasmontano/twitch)
- [Python (Second Edition)](https://github.com/lucasmontano/magic-link)
- [Flutter / Dart Third Edition](https://github.com/lucasmontano/learn-tech)


## How to contribute

- Fork the project
Expand All @@ -19,9 +20,31 @@ Previous Editions's Programming Languages
- Merge your Pull Request and close the Issues

### Important Notes

- Write your code, Issues and Pull Requests in English
- Avoid big Pull Requests and split your work properly

### Project Setup

Youtube API Developer Key: [Check Getting Started](https://developers.google.com/youtube/v3/getting-started)

- `export YOUTUBE_DEVELOPER_KEY=YOUR_KEY`

- Generate your client_secret.json:
> [Youtube Go Quickstart](https://developers.google.com/youtube/v3/quickstart/go)

### Running application

- First, you must have the go compiler installed on your machine

> [Official Docs from Golang website](https://golang.org/doc/install)

- Then, you must go to terminal and make:

```bash
cd youtuber-description-links
go get -v -t -d ./...
go run .
```

> **Note:** On your first running, your must have copy the link appear on the terminal, open this on web browser, authorize access and copy authentication code and paste on the terminal.