-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
67f6786
commit e268ef3
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,34 @@ | ||
# movies-watchlist | ||
The simple bot to share your favourite movies with friends | ||
|
||
## Getting started | ||
|
||
The appropriate way to run the app is in a docker container, so to have the docker installed is the only prerequisite for the app | ||
|
||
### Installation | ||
|
||
You can just copy the repo without installing any additional packages | ||
|
||
``` | ||
$ git clone https://github.com/NPodlozhniy/movies-watchlist.git | ||
$ cd movies-watchlist | ||
``` | ||
|
||
### Usage | ||
|
||
Even if you don't have Python installed this option will work well for you | ||
|
||
The only thing you should do is to set an environment variable - the token of your bot | ||
``` | ||
export TOKEN=<YOUR TOKEN> (use 'set' instead of 'export' for Windows) | ||
``` | ||
|
||
Then choose the way how you want your movies list will be mounted and run the appropriate command: | ||
- [bind mount](https://github.com/NPodlozhniy/movies-watchlist/blob/master/bind_mount_run.sh) | ||
- [volume](https://github.com/NPodlozhniy/movies-watchlist/blob/master/volume_run.sh) | ||
|
||
_Important Notes:_ | ||
|
||
a) For `Windows` you should replace Linux speciefic syntax: `$TOKEN` with `%TOKEN%` and `$pwd` with `%cd%` and | ||
|
||
b) if it doesn't work transform the commands into the one row |