Skip to content
This repository has been archived by the owner on Jul 26, 2020. It is now read-only.

Update documentation, import paths and fixed spelling of videos.go #5

Merged
merged 2 commits into from
Apr 19, 2019
Merged
Show file tree
Hide file tree
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
17 changes: 3 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,14 @@
# Contributing

Thank you so much for helping us build [BreadTube.tv](https://BreadTube.tv), an open source media distribution platform for simplifying the sharing of the massively important content coming out of the BreadTube movement.
Thank you so much for helping us build [BreadTube.tv](https://BreadTube.tv) and the bake CLI, for more information about [BreadTube.tv](https://BreadTube.tv) please visit its repo [here](https://github.com/breadtubetv/breadtubetv)

We're looking for any help you can offer, including but not limited to advising us on what playlists we should put together.

If you're a creator we really want to know what information you would like on here, and also if you would like your own free and open source version of the platform, eg [yourchannel.breadtube.tv](#contributing) or [yourchannel.tv](#contributing) _(all hosting costs will be covered by donors)_.
[README](https://github.com/breadtubetv/bake/#bake) is the first place to go to learn everything about the project.

[README](https://github.com/breadtubetv/breadtubetv/#breadtubetv) is the first place to go to learn everything about the project.

[The Issues](https://github.com/breadtubetv/breadtubetv/issues) section is a great place to add ideas about expanding the platform
[The Issues](https://github.com/breadtubetv/bake/issues) section is a great place to add ideas about expanding the platform

You can also visit [BreadTube.tv](https://breadtube.tv) to find other platforms where this content is being distributed.

## Development

### Creating a Playlist

- [Create a New File](https://github.com/breadtubetv/breadtubetv/new/master/content/playlists) under [content/playlists/](https://github.com/breadtubetv/breadtubetv/tree/master/content/playlists) (ProTip: [Copy an existing one](https://github.com/breadtubetv/breadtubetv/blob/master/content/playlists/welcome.md))
- Add the video ids you want into the new [Playlist Front Matter](https://gohugo.io/content-management/front-matter/)
- Add the videos you need to [`data/videos.yml`](https://github.com/breadtubetv/breadtubetv/blob/master/data/videos.yml)
- Add the channels you need to [`data/channels.yml`](https://github.com/breadtubetv/breadtubetv/blob/master/data/channels.yml)

Thank you.
[BreadTube.tv Team](https://github.com/orgs/breadtubetv/people)
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (C) 2019 BreadTube.tv github.com/breadtubetv/breadtubetv
Copyright (C) 2019 BreadTube.tv github.com/breadtubetv/bake

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
119 changes: 17 additions & 102 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,8 @@
# [BreadTube.tv](https://breadtube.tv)
# BreadTube Bake CLI

This project aims to list anti-establishment public YouTubers for simplified onboarding of new members to the cause.
The `bake` cli is a companion CLI to the [breadtubetv/breadtubetv](https://github.com/breadtubetv/breadtubetv) project.

[Check out the announcement on r/breadtube to follow the discussion](https://www.reddit.com/r/BreadTube/comments/ahxwrm/breadtubetv_is_live_and_open_source_you_can_help/).

Growing from this base we want to build a platform which elevates content creators far beyond what YouTube can currently offer, and gives them resilience from being censored or deplatformed.

For now though this is a *_really simple_* website

- Channels can be added to the homepage under `data/channels.yml`
- Videos can be added to the homepage under `data/channels.yml`
- Playlists can be created to link to videos and channels
- Social media can be changed in`config.toml`.

We'd like to simplify the process for adding content, [this is a project you can help with](https://github.com/breadtubetv/breadtubetv/issues/22)!

## Dependencies

## [Hugo (https://gohugo.io/)](https://gohugo.io/)

## Content Development

```
hugo serve
open localhost:1313
```

## [Contributing](https://github.com/breadtubetv/breadtubetv/blob/master/CONTRIBUTING.md)

### Configuring the `bake` CLI

The `.bake.yaml` configuration file can be stored in the following locations:

- `$HOME/.bake.yaml`
- `./bake.yaml` (In other words, the current directory from which you're running the CLI)

Current configuration options and default values:

- `projectRoot: "../"` : Directory of channel data files.
E.g. `$GOPATH/src/github.com/breadtubetv/breadtubetv/data/channels`

### Adding a Channel

#### [Walkthrough Video](https://youtu.be/jpOun7YXFpg) (Out of date)

You can use the `bake` CLI, instructions [here](#Importing-a-Channel) to add channels OR

- Create a `<channelName>.yaml` file in [`data/channels/`](https://github.com/breadtubetv/breadtubetv/blob/master/data/channels)
- Fill in the required information:
```yaml
name: Readable Name
permalink: <slug>
providers:
twitter:
name: Readable Name
slug: username
url: https://www.twitter.com/<username>
youtube:
name: Readable Name
slug: youtube-id
url: https://www.youtube.com/channel/<youtube-id>
subscribers: 9000
slug: <slug>
tags:
- breadtube
```
- Create a `<channelName>.md` file in [`content`](https://github.com/breadtubetv/breadtubetv/blob/master/content)
- Follow this example format:
```
---
title: "<Readable Name>"
type: "channels"
channel: "<slug>"
menu:
main:
parent: "Channels"
videos:
- abc123def
---
- Download the image and save it to [`static/img/channels/`](https://github.com/breadtubetv/breadtubetv/blob/master/static/img/channels)

### Creating a Playlist

- [Create a New File](https://github.com/breadtubetv/breadtubetv/new/master/content/playlists) under [content/playlists/](https://github.com/breadtubetv/breadtubetv/tree/master/content/playlists) (ProTip: [Copy an existing one](https://github.com/breadtubetv/breadtubetv/blob/master/content/playlists/welcome.md))
- Add the video ids you want into the new [Playlist Front Matter](https://gohugo.io/content-management/front-matter/)
- Add the videos you need to [`data/videos.yml`](https://github.com/breadtubetv/breadtubetv/blob/master/data/videos.yml)
- Add the channels you need to [`data/channels.yml`](https://github.com/breadtubetv/breadtubetv/blob/master/data/channels.yml)

## Script Development
## [Contributing](https://github.com/breadtubetv/bake/blob/master/CONTRIBUTING.md)

Scripts are being written in Go, this keeps the scripting and operational language the same, provides cross system compatibility, and gives everyone an opportunity to learn a new programming language.

Expand All @@ -102,8 +17,8 @@ This is going to be dependent on your system, we recommend following https://gol
You'll need a copy of the project in your `$GOPATH`.

```
go get github.com/breadtubetv/breadtubetv
cd $GOPATH/github.com/breadtubetv/breadtubetv/bake
go get github.com/breadtubetv/bake
cd $GOPATH/github.com/breadtubetv/bake
```

And you'll need to install bake's dependencies with:
Expand All @@ -120,6 +35,18 @@ This will put the `bake` command in your path:
go install
```

#### Configuring the `bake` CLI

The `.bake.yaml` configuration file can be stored in the following locations:

- `$HOME/.bake.yaml`
- `./bake.yaml` (In other words, the current directory from which you're running the CLI)

Current configuration options and default values:

- `projectRoot: "../"` : Directory of channel data files.
E.g. `$GOPATH/src/github.com/breadtubetv/breadtubetv/data/channels`

#### Importing a Channel

You can run bake directly from the source like so:
Expand All @@ -144,15 +71,3 @@ Bake has some very basic tests for now, they can be run with the standard go tes
go get -t ./...
go test ./...
```

## Staging

Pull requests are automatically deployed to a self contained environment for review.

## Production

### Hosting

While this is a simple Hugo website, hosting is on [netlify.com](https://netlify.com).

## Forestry
2 changes: 1 addition & 1 deletion cmd/import.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"os"
"strings"

"github.com/breadtubetv/breadtubetv/bake/util"
"github.com/breadtubetv/bake/util"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"os"
"path/filepath"

"github.com/breadtubetv/breadtubetv/bake/providers"
"github.com/breadtubetv/bake/providers"

homedir "github.com/mitchellh/go-homedir"
"github.com/spf13/cobra"
Expand Down
4 changes: 2 additions & 2 deletions cmd/update.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import (
"log"
"os"

"github.com/breadtubetv/breadtubetv/bake/providers"
"github.com/breadtubetv/breadtubetv/bake/util"
"github.com/breadtubetv/bake/providers"
"github.com/breadtubetv/bake/util"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package main

import (
"github.com/breadtubetv/breadtubetv/bake/cmd"
"github.com/breadtubetv/bake/cmd"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion providers/youtube.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import (
"runtime"
"strings"

"github.com/breadtubetv/breadtubetv/bake/util"
"github.com/breadtubetv/bake/util"
"golang.org/x/net/context"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
Expand Down
2 changes: 1 addition & 1 deletion providers/youtube_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package providers
import (
"testing"

"github.com/breadtubetv/breadtubetv/bake/util"
"github.com/breadtubetv/bake/util"
"github.com/stretchr/testify/assert"
)

Expand Down
File renamed without changes.