invidious/README.md

65 lines
1.1 KiB
Markdown
Raw Normal View History

2017-11-30 05:42:23 +05:30
# Invidious
2017-11-23 13:18:55 +05:30
2018-03-09 22:18:01 +05:30
> Invidious is what YouTube should be
2017-11-23 13:18:55 +05:30
## Installation
2018-01-29 08:01:35 +05:30
### Installing [Crystal](https://github.com/crystal-lang/crystal):
On Arch:
2018-03-09 22:18:01 +05:30
2018-01-29 08:01:35 +05:30
```bash
$ sudo pacman -Syu shards crystal
$ crystal deps
```
On OSX:
2018-03-09 22:18:01 +05:30
2018-01-29 08:01:35 +05:30
```bash
$ brew update
$ brew install shards crystal-lang
$ crystal deps
```
### Installing Postgres:
2018-01-29 08:28:41 +05:30
On Arch:
2018-03-31 19:38:49 +05:30
Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL)
2018-01-29 08:28:41 +05:30
2018-01-29 08:01:35 +05:30
On OSX:
2018-03-09 22:18:01 +05:30
2018-01-29 08:01:35 +05:30
```bash
$ brew install postgres
```
2018-03-09 22:18:01 +05:30
Then setup database with
2018-01-29 08:28:41 +05:30
```bash
$ ./setup.sh
```
2018-01-29 08:01:35 +05:30
## Usage:
2017-11-23 13:22:37 +05:30
```bash
2018-01-29 08:01:35 +05:30
$ crystal src/invidious.cr
2017-11-23 13:22:37 +05:30
```
2017-11-23 13:18:55 +05:30
2018-01-29 08:01:35 +05:30
Or for development:
2018-03-09 22:18:01 +05:30
2017-11-23 13:22:37 +05:30
```bash
2018-01-29 08:01:35 +05:30
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
2017-11-23 13:22:37 +05:30
```
2017-11-23 13:18:55 +05:30
## Contributing
2018-03-09 22:18:01 +05:30
1. Fork it ( https://github.com/omarroth/invidious/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
2017-11-23 13:18:55 +05:30
## Contributors
2018-03-09 22:18:01 +05:30
* [omarroth](https://github.com/omarroth) - creator, maintainer