summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 00d0294dfb338d282bb1be6bb20f0eac19e8619a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# Invidious

> Invidious is a web application that indexes popular video sites

## Installation

### Installing [Crystal](https://github.com/crystal-lang/crystal):

On Arch:
```bash
$ sudo pacman -Syu shards crystal
$ crystal deps
```

On OSX:
```bash
$ brew update
$ brew install shards crystal-lang
$ crystal deps
```

### Installing Postgres:

Onn Arch:
Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL), then setup database with:
```bash
$ ./setup.sh
```
On OSX:
```bash
$ brew install postgres
```

## Usage:

```bash
$ crystal src/invidious.cr
```

Or for development:
```bash
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
```

## Contributing

1. Fork it ( https://gitlab.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

## Contributors

- [omarroth](https://github.com/omarroth) - creator, maintainer