LBRYFoundation/lbry.com
1
0
Fork 0
mirror of https://github.com/LBRYFoundation/lbry.com.git synced 2025-08-23 09:37:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README and INSTALL cleanup to evaluate new doc standards

Browse source
This commit is contained in:
Jeremy Kauffman 2018-02-15 19:06:43 -05:00
parent 6f28ae433c
commit 36fb84f136
2 changed files with 51 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
INSTALL.md Normal file
View file

@ -0,0 +1,29 @@
# Installation
## Prerequisites
To run this project, you'll need to have either PHP7 or Docker installed, and be using either macOS or Linux.
## Running Locally
- Install PHP7
- Checkout the project
- Run `./dev.sh` from the project root
- Access [localhost:8000](http://localhost:8000) in your browser
## Running via Docker
- Install Docker
- Checkout the project
- Run `./docker.sh` from the project root
- Access [localhost:8000](http://localhost:8000) in your browser
## Verifying Install
If `localhost:8000` returns the lbry.io website, it's running correctly.
## Additional Notes
- Both the `dev.sh` and `docker.sh` scripts will initialise a configuration based on `data/config.php.example` if `data/config.php` does not exist.
- Some pages and interactions rely on API keys that will not be available to you in your install.
- To run remotely, simply install PHP and configure Apache or your server of choice to serve `web/index.php`.

37
README.md
View file

@ -1,25 +1,32 @@
# lbry.io
The [lbry.io](https://lbry.io) website.
The [lbry.io](https://lbry.io) website. This website uses barebones PHP along with Javascript and SCSS.
## Running lbry.io
![lbry.io screenshot](https://spee.ch/@lbry/lbryio.png)
It's very easy to have lbry.io running locally:
## Installation
- Install PHP7
- Checkout the project
- Run `./dev.sh` from the project root
- Access [localhost:8000](http://localhost:8000) in your browser
Please see [INSTALL](INSTALL.md) for comprehensive, easy-to-follow instructions on running this project.
You can also run the development server using docker:
## Usage
- Install Docker
- Checkout the project
- Run `./docker.sh` from the project root
- Access [localhost:8000](http://localhost:8000) in your browser
Unless you are planning to contributing to the lbry.io website, this project serves little independent purpose.
Both the `dev.sh` and `docker.sh` scripts will initialise a configuration based on `data/config.php.example` if `data/config.php` does not exist.
To access a local copy of lbry.io, follow [INSTALL](INSTALL.md) and then access localhost:8000 in your browser.
To run remotely, simply install PHP and configure Apache or your server of choice to serve `web/index.php`.
## License
Note that some pages and interactions rely on API keys that will not be available to you in your install.
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING](https://lbry.io/faq/contributing).
## Contact
The primary contact for this project is Jeremy Kauffman <jeremy@lbry.io>.
## Additional Info and Links
- [https://lbry.io](https://lbry.io) - The live LBRY website
- [https://chat.lbry.io](https://chat.lbry.io) - A chat room for the LBRY community