You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
invidious/README.md

75 lines
1.2 KiB
Markdown

7 years ago
# Invidious
7 years ago
7 years ago
> Invidious is what YouTube should be
7 years ago
## Installation
### Installing [Crystal](https://github.com/crystal-lang/crystal):
6 years ago
#### On Arch:
7 years ago
```bash
$ sudo pacman -S shards crystal
6 years ago
$ shards
```
6 years ago
#### On OSX:
7 years ago
```bash
$ brew update
$ brew install shards crystal-lang
6 years ago
$ shards
```
### Installing Postgres:
6 years ago
#### On Arch:
Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL)
6 years ago
#### On OSX:
7 years ago
```bash
$ brew install postgres
```
6 years ago
### Setup Postgres:
7 years ago
```bash
$ ./setup.sh
```
6 years ago
### Installing ImageMagick (required for CAPTCHA):
#### On Arch:
```bash
$ sudo pacman -S imagemagick librsvg
6 years ago
```
## Usage:
7 years ago
```bash
6 years ago
$ crystal build src/invidious.cr
$ ./invidious
7 years ago
```
7 years ago
Or for development:
7 years ago
7 years ago
```bash
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
7 years ago
```
7 years ago
## Contributing
7 years ago
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
7 years ago
## Contributors
6 years ago
- [omarroth](https://github.com/omarroth) - creator, maintainer