bytesized.tv-monorepo

``text
.--.
_( . .
( ) \ /
( . ) ) .-----\/-----.
--(___.-' |bytesized.tv|
'-----__-----'
__||__
``

[![tests][tests]][tests-url]
[![buddy pipeline][buddy]][buddy-url]
[![npm][npm]][npm-url]
[![license][license]][license-url]
[![deploy][deploy]][deploy-url]

[tests]: https://img.shields.io/travis/jsbites/bytesized.tv-monorepo.svg
[tests-url]: https://travis-ci.org/jsbites/bytesized.tv-monorepo
[buddy]: https://app.buddy.works/volkanozcelik/bytesized-tv-monorepo/pipelines/pipeline/124991/badge.svg?token=1a9b7035c764acc1b6e3d12eb1fb375d15665b0b5da3a6f6a856a8d972b1f05e
[buddy-url]: https://app.buddy.works/volkanozcelik/bytesized-tv-monorepo/pipelines/pipeline/124991
[npm-url]: https://www.npmjs.com/package/jedifocus.api
[npm]: https://img.shields.io/npm/v/jedifocus.api.svg
[deploy]: https://img.shields.io/github/last-commit/jsbites/jedifocus.api.svg?label=last%20deployed
[deploy-url]: https://github.com/jsbites/jedifocus.api/
[license]: https://img.shields.io/npm/l/jedifocus.api.svg
[license-url]: https://www.npmjs.com/package/jedifocus.api

bytesized.tv-monorepo is the monorepository that contains all the sub-projects
that help create and maintain the public website of Byte-Sized JavaScript
Screencasts.

Important Files and Folders

* ./packages/: This folder contains all sub-repositories (or _packages_, as the
name implies).
* ./packages/byte-sized-tv-application/: This package is used to fetch metadata
of the episode from YouTube.
* ./packages/byte-sized-tv-web/: This is the main website.
* ./packages/byte-sized-tv-web-app/: This is the web app that
byte-sized-tv-web package consumes.
* ./packages/byte-sized-tv-web-body/: The body of the web application.
* ./packages/byte-sized-tv-web-card/: Individual card components that you
see on the home page.
* ./packages/byte-sized-tv-web-constants/: Commonly-shared constants.
* ./packages/byte-sized-tv-web-episode/: The component that displays the
“_episode details_” and “_episode transcript_”.
* ./packages/byte-sized-tv-web-footer/: The footer of the web application.
* ./packages/byte-sized-tv-web-header/: The header of the web application.
* ./packages/byte-sized-tv-web-home/: The home page that you see when you go
to website root.
* ./packages/byte-sized-tv-web-labels/: The labels that you see on the top
of cards.
* ./packages/byte-sized-tv-web-lib: Common library functions.
* ./packages/byte-sized-tv-web-posts/: This package contains the markdown
files that contain the transcripts of individual episodes.
* ./packages/byte-sized-tv-web-styles/: Stylesheets that are used within the
web application.

Installation

> Note that you can view the website online at ; and you
> don’t need to install anything for that obviously :).
>
> This “Installation” section is specifically targeted for development use only —
> That is to say, this section is intended for those who want to clone this
> repository and play with it on their local development environment.

Make sure you have [Node.js][node], and [yarn][yarn] installed on your system.
Then install the dependencies as follows:

`bash
yarn bootstrap
`

After that running the following command will start the server in “_development mode_”.

`bash
yarn start
`

Package Scripts

Here are some of the common package scripts.

* yarn bootstrap: Cleans the repository, installs the dependencies, and
yarn links the local packages for ease of development.
* yarn build: Creates a production build of the web application. After
the build is done, the end result is put to ./packages/byte-sized-tv-web/public/.
* yarn start: Starts the webpack server for ./packages/bytesized-tv-web in
development mode.
* yarn serve: Launches a basic http-server rooted at ./packages/byte-sized-tv-web/public/.
* yarn test: Runs tests across all the packages.
* yarn publish:packages: Publishes all of the changed packages under ./packagesto
npm, and also updates package versions.
* yarn generate:transcripts: Generates transcript html files by parsing the markdown
files that live under ./packages/byte-sized-tv-web-posts/.

Other Important Files

* .eslintrc: Static analysis rules.
* .prettierrc: [prettier][prettier] rules.
* .travis.yml`: [Travis CI][travis] configuration.
* CHANGELOG.md: The change log.
* DEPLOY.md: Deployment instructions.
* CODE_OF_CONDUCT.md: The code of conduct.
* CONTRIBUTING.md

Deployment Instructions

> This section is intended for those who have authorization to deploy
> bytesized.tv to production.

For deployment follow this quick and dirty guide

Wanna Help?

Any help is more than appreciated.

If you want to contribute to the source code, fork this repository and
create a pull request.

> In lieu of a formal style guide, take care to maintain the existing coding style.

Also, don’t forget to add unit tests for any new or changed functionality.

If you want to report a bug; or share a comment or suggestion, file an issue.

I’ve Found a Bug; I Have an Idea

For bug reports and suggestions, please file an issue.

Contact Information

* Project Maintainer: Volkan Özçelik
* Project Website: bytesized.tv

License

MIT-licensed. — See the license file for details.

Code of Conduct

We are committed to making participation in this project a harassment-free experience
for everyone, regardless of the level of experience, gender, gender identity and
expression, sexual orientation, disability, personal appearance, body size, race,
ethnicity, age, religion, or nationality.

See the code of conduct for details.

A [ByteSized.TV][vidcast] Project

This repository is a part of the [Byte-Sized JavaScript VideoCasts][vidcast].

It is a compilation of short (_around ten minutes_) screencasts about JavaScript
and related technologies.

[Learn, explore, and have fun][vidcast]!

[vidcast]: https://bytesized.tv/ 'ByteSized.TV'
[node]: https://nodejs.org/ 'Node.js'
[yarn]: https://yarnpkg.com/ 'Yarn'
[prettier]: https://prettier.io/ 'Prettier'