invidious-copy-2022-08-14/README.md

60 lines
1.1 KiB
Markdown
Raw Normal View History

2017-11-30 00:12:23 +00:00
# Invidious
2017-11-23 07:48:55 +00:00
2018-01-29 02:31:35 +00:00
> Invidious is a web application that indexes popular video sites
2017-11-23 07:48:55 +00:00
## Installation
2018-01-29 02:31:35 +00:00
### 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:
2018-01-29 02:58:41 +00:00
On Arch:
Install according to the [wiki](https://wiki.archlinux.org/index.php/PostgreSQL#Installing_PostgreSQL):
2018-01-29 02:31:35 +00:00
On OSX:
```bash
$ brew install postgres
```
2018-01-29 02:58:41 +00:00
Then setup database with:
```bash
$ ./setup.sh
```
2018-01-29 02:31:35 +00:00
## Usage:
2017-11-23 07:52:37 +00:00
```bash
2018-01-29 02:31:35 +00:00
$ crystal src/invidious.cr
2017-11-23 07:52:37 +00:00
```
2017-11-23 07:48:55 +00:00
2018-01-29 02:31:35 +00:00
Or for development:
2017-11-23 07:52:37 +00:00
```bash
2018-01-29 02:31:35 +00:00
$ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/install.cr | crystal eval
$ ./sentry
2017-11-23 07:52:37 +00:00
```
2017-11-23 07:48:55 +00:00
## Contributing
2017-11-30 00:12:23 +00:00
1. Fork it ( https://gitlab.com/omarroth/invidious/fork )
2017-11-23 07:48:55 +00:00
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
2017-11-23 07:52:37 +00:00
- [omarroth](https://github.com/omarroth) - creator, maintainer