Installation and Setup

This section will go over how to install Orthodox Presenter on your own machine as well as how to set up the staging environment with GitHub. Note that these instructions are meant for those who are unfamiliar with github and node.js and other systems. If you know how to use these systems, you may skip this section or refer back to it for troubleshooting.

Before you begin

Listed below, you will find all of the necessary programs you are going to need to run Orthodox Presenter locally on your machine as well as the software needed to run git commands.

• Git is the version control system that GitHub utilizes. By installing this for your appropriate system, you will be able to run git commands in Command Prompt (Windows) or Terminal (macOS & Linux, set up your staging area, as well as initiate Pull Requests to the Orthodox Presenter repo.

• Node.js and the local-web-server package is how you can test your local copy of Orthodox Presenter. Installing it will allow you to run node.js commands in Command Prompt (Windows) or Terminal (macOS & Linux).

• VSCode is a code text editor.

Setting up Orthodox Presenter and Github

After you have installed all of the above items, you are going to need to fork the original repo. This can be done simply by clicking the fork button located on the top of the screen.

Now that you have forked the repo, you will need to clone the repo to your machine. The commands for git will be different. Below, you will find the appropriate commands used for Windows

First, open Command Prompt and go to a specific directory on your computer. This can be achieved by typing cd and then the name of the directory. For example, if you would like to have your forked version of Orthodox Presenter on your desktop, type cd desktop

Next, go to your forked version of Orthodox Presenter. You will see a green button that says Clone or download. Clicking that button will bring up a dialogue which will says Clone with HTTPS. Click the clipboard icon to copy the url to your clipboard.

Ensuring that you are in the appropriate directory that you want to clone the project to, simply type in git clone and then past your clipboard. It should like this git clone https://github.com/YOURUSERNAME/orthodox-presenter.git

Syncing the fork to the original project

Detailed instructions for this part can be found here however the abriged version can be found below.

• cd into the cloned directory
• type git remote -v
• type git remote add upstream https://github.com/dbishai/orthodox-presenter.git (upstream is the original repo from where your cloned version is from)
• To verify that the upstream repo was added, type git remote -v. Your fork should appear as origin and the URL for the original repo should appear as upstream

Github Git Cheatsheet for most used git commands

Adding Orthodox Presenter as a project directory in VS Code

Once you have verified that you synced the fork successfully begin writing content for Orthodox Presenter. An easy way to do this is to add the Orthodox Presenter directory as a project directory in VS Code.

There are currently two folders that make up the content for Orthodox Presenter

• Hymns
• Prayers

If you are writing Hymn content, create the new file within the hymns folder and then name the file with a descriptive title, ensuring that it ends in .json. Refer to the guidlines for additional information on formatting.

You will notice that some folders may have sub-folders. Use them when appropriate.

Testing Orthodox Presenter

First, open Command Prompt (Windows) or Terminal (macOS & Linux) and cd into the Orthodox Presenter directory. From there, run the command npm start. Then open another instance of Command Prompt or Terminal and run ws

Troubleshooting

Error: Watchify is not recognized as an internal or external command

Solution Make sure the watchify package is installed npm install -g watchify