ryan/sermon-notes
1
0
Fork 0
Code Issues 3 Pull Requests Packages Releases 1 Wiki Activity

Fix install instructions

Browse Source
This commit is contained in:
Ryan Prather 2024-05-25 08:01:46 -04:00
parent 7044d16ee0
commit 11f566897f
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,7 +4,9 @@ A program to take notes during a sermon. The web app was built with PHP and Sym
## Installation ## Installation
The best option for installing is using the Docker container. Download the `docker-compose.yml` file from this repository and run `docker-compose up -d` from the command line. 1. Run `docker run -d --name sermon-notes -p 80:80 ryanprather/sermon-notes:latest`, this will download and start the container and keep it running in the background. If you already have something on port 80 change the first `80` to whatever open port you'd like.
2. Run `docker exec -it sermon-notes bash install.sh` This will run an install script to create an .env file specific to your install, populate with the beginning factors, and then run a `composer` command to download the necessary package dependancies.
3. Once complete you have a running system that you can navigate to in your browser with `http://{ip}:{port}|{hostname}:{port}`. Then you just need to register for an account. The first account that is created is made an admin so that you can access the `Reference Editor` and update any reference material if necessary.
## Operation ## Operation
@ -24,7 +26,7 @@ Once you get logged in you'll be presented with the main home page
![HomePage](/assets/images/HomePage.png) ![HomePage](/assets/images/HomePage.png)
If you are accessing on a regular iPad the menu should be collapsed, if not, you may need to do that. I built this with a iPad 9th Gen in mind so your mileage may vary. If you are accessing on a regular iPad the menu should be collapsed, if not, you may need to do that. I built this with a iPad 9th Gen in mind so visibility on another device may vary.
![Header](/assets/images/Header.png) ![Header](/assets/images/Header.png)
@ -62,5 +64,5 @@ or if the note was recently made you will see the most recent 4 notes listed und
![RecentNotes](/assets/images/RecentNotes.png) ![RecentNotes](/assets/images/RecentNotes.png)
By click either of the title links it will open the note and display it for you to edit or read. I can add "Notes" as future reference content. By clicking either of the title links it will open the note and display it for you to edit or read. I can add "Notes" as future reference content.