Skip to content

Commit

Permalink
Merge pull request #151 from Stardown-app/fix-misc
Browse files Browse the repository at this point in the history 
Link to latest zip files, fix browser selection, improve instructions
  • Loading branch information
@wheelercj
wheelercj authored Nov 12, 2024
2 parents a74a10d + 6d2e000 commit fa179a2
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 43 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/release.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ jobs:
cp README.md LICENSE firefox
echo "Copying docs into folder"
cp -r docs firefox/docs
cd firefox
echo "Zipping folder into stardown-${{ github.ref_name }}-firefox.zip"
zip -r "stardown-${{ github.ref_name }}-firefox.zip" firefox
- name: Build for Chrome
Expand All @@ -41,13 +42,14 @@ jobs:
cp README.md LICENSE chrome
echo "Copying docs into folder"
cp -r docs chrome/docs
cd chrome
echo "Zipping folder into stardown-${{ github.ref_name }}-chrome.zip"
zip -r "stardown-${{ github.ref_name }}-chrome.zip" chrome
zip -r "stardown-${{ github.ref_name }}-chrome.zip" .
- name: Release
uses: softprops/action-gh-release@v2
if: startsWith(github.ref, 'refs/tags/')
with:
generate_release_notes: true
files: |
stardown-${{ github.ref_name }}-firefox.zip
stardown-${{ github.ref_name }}-chrome.zip
firefox/stardown-${{ github.ref_name }}-firefox.zip
chrome/stardown-${{ github.ref_name }}-chrome.zip
2 changes: 1 addition & 1 deletion chrome/browserSpecific.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ export async function handleCopyRequest(text) {
try {
await navigator.clipboard.writeText(text);
} catch (err) {
console.error('navigator.clipboard.writeText:', err);
console.error('navigator.clipboard.writeText:', err.message);
console.log('Using fallback method to write text to the clipboard.');

const textarea = document.createElement('textarea');
Expand Down
72 changes: 72 additions & 0 deletions docs/install and update instructions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,59 @@ <h1>
</header>

<main>
<noscript>
<p>
You can install Stardown from
<a href="https://chrome.google.com/webstore/detail/clicknohlhfdlfjfkaeongkbdgbmkbhb" target="_blank">
the Chrome Web Store</a>
or from
<a href="https://addons.mozilla.org/en-US/firefox/addon/stardown/" target="_blank">
Add-ons for Firefox</a>.
</p>
<p>If you would prefer to install from source, there are two methods:</p>
<h2>
Install with <a href="https://git-scm.com">Git</a>
and <a href="https://nodejs.org">Node v14+</a>
</h2>
<ol>
<li>
Run <code>git clone https://github.com/Stardown-app/Stardown.git && cd stardown</code>
</li>
<li>
Run <code>npm install</code>
</li>
<li>
Then run <code>npm run build-firefox</code> for Firefox or <code>npm run
build-chrome</code> for a Chromium browser (Chrome, Edge, Brave, Vivaldi, Opera, Arc, etc.)
</li>
<li>
In your browser, open <code>about:debugging#/runtime/this-firefox</code>
in Firefox or <code>chrome://extensions/</code> in a Chromium browser
</li>
<li>If you're using a Chromium browser, turn on developer mode</li>
<li>Click "Load Temporary Add-on..." or "Load unpacked"</li>
<li>
If in Firefox, select Stardown's <code>firefox/manifest.json</code> file.
If in a Chromium browser, select Stardown's <code>chrome</code> folder.
</li>
</ol>
<h2>Install with a .zip file</h2>
<ol>
<li>
<a href="https://github.com/Stardown-app/Stardown/releases/latest" target="_blank">
Download the .zip file</a> named after your browser
</li>
<li>Unzip the .zip file</li>
<li>
If in Firefox, select the <code>manifest.json</code> file.
If in a Chromium browser, select the folder.
</li>
</ol>
<hr />
<p>The form below only works when JavaScript is enabled.</p>
<hr />
</noscript>

<form>
<fieldset>
<div class="option">
Expand All @@ -48,6 +101,25 @@ <h1>
</div>
</fieldset>

<fieldset>
<legend>Browser</legend>

<div class="option">
<input type="radio" id="chromium" name="browser" value="chromium" checked />
<label for="chromium">Chromium (Chrome, Edge, Brave, Vivaldi, Opera, Arc, etc.)</label>
</div>

<div class="option">
<input type="radio" id="firefox" name="browser" value="firefox" />
<label for="firefox">Firefox</label>
</div>

<div class="option">
<input type="radio" id="safari" name="browser" value="safari" />
<label for="safari">Safari</label>
</div>
</fieldset>

<!-- if updating -->
<fieldset id="installedWith">
<legend>How did you install Stardown?</legend>
Expand Down
93 changes: 54 additions & 39 deletions docs/install and update instructions/script.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,17 @@
// See the License for the specific language governing permissions and
// limitations under the License.

const isWindows = navigator.userAgent.includes('Windows');

const isChromium = navigator.userAgent.includes('Chrome'); // https://developer.mozilla.org/en-US/docs/Web/API/Window/navigator#example_1_browser_detect_and_return_a_string
const isFirefox = navigator.userAgent.includes('Firefox');
const isSafari = navigator.userAgent.includes('Safari');

const instructionsEl = document.querySelector('#instructions');
const formEl = document.querySelector('form');

// fieldsets that start hidden
const installedWithEl = document.querySelector('#installedWith');
const willInstallWithEl = document.querySelector('#willInstallWith');
const hasNodeV14PlusEl = document.querySelector('#hasNodeV14Plus');

// radio inputs
const chromiumEl = document.querySelector('#chromium');
const firefoxEl = document.querySelector('#firefox');
const safariEl = document.querySelector('#safari');
const installingEl = document.querySelector('#installing');
const updatingEl = document.querySelector('#updating');
const installedWithStoreEl = document.querySelector('#installedWithStore');
Expand All @@ -43,6 +39,22 @@ installedWithEl.setAttribute('hidden', 'hidden');
willInstallWithEl.setAttribute('hidden', 'hidden');
hasNodeV14PlusEl.setAttribute('hidden', 'hidden');

const isWindows = navigator.userAgent.includes('Windows');

// [How to determine the current browser](https://stackoverflow.com/questions/9847580/how-to-detect-safari-chrome-ie-firefox-and-opera-browsers#answer-9851769)
// There is no completely reliable way, so users should be able to select their browser.
chromiumEl.checked = Boolean(window.chrome);
firefoxEl.checked = typeof InstallTrigger !== 'undefined' && !chromiumEl.checked;
safariEl.checked = (
navigator.vendor &&
/Apple Computer, Inc\./i.test(navigator.vendor) &&
!chromiumEl.checked &&
!firefoxEl.checked
);

chromiumEl.addEventListener('change', main);
firefoxEl.addEventListener('change', main);
safariEl.addEventListener('change', main);
installingEl.addEventListener('change', main);
updatingEl.addEventListener('change', main);
installedWithStoreEl.addEventListener('change', main);
Expand All @@ -64,25 +76,28 @@ class Instructions {
function main() {
const instructions = new Instructions();

if (!isChromium && !isFirefox && !isSafari) {
instructions.text = `Unknown browser: ${navigator.userAgent}`;
formEl.setAttribute('hidden', 'hidden');
} else if (isSafari) {
instructions.text = 'Safari support coming soon!';
formEl.setAttribute('hidden', 'hidden');
} else if (installingEl.checked) {
install(instructions);
} else if (updatingEl.checked) {
update(instructions);
} else {
throw new Error('Neither installing nor updating');
if (chromiumEl.checked || firefoxEl.checked || safariEl.checked) {
if (safariEl.checked) {
instructions.text = 'Safari support coming soon!';
willInstallWithEl.setAttribute('hidden', 'hidden');
installedWithEl.setAttribute('hidden', 'hidden');
hasNodeV14PlusEl.setAttribute('hidden', 'hidden');
} else if (installingEl.checked) {
install(instructions);
} else if (updatingEl.checked) {
update(instructions);
} else {
throw new Error('Neither installing nor updating');
}
}

if (instructions.text || instructions.steps.length > 0) {
showInstructions(instructions);
} else {
instructionsEl.setAttribute('hidden', 'hidden');
}

window.scrollTo(0, document.body.scrollHeight);
}

function install(instructions) {
Expand Down Expand Up @@ -126,12 +141,12 @@ function update(instructions) {
}

function installWithStore(instructions) {
if (isChromium) {
if (chromiumEl.checked) {
instructions.text = `
<a href="https://chrome.google.com/webstore/detail/clicknohlhfdlfjfkaeongkbdgbmkbhb" target="_blank">
Install Stardown from the Chrome Web Store</a>
`;
} else if (isFirefox) {
} else if (firefoxEl.checked) {
instructions.text = `
<a href="https://addons.mozilla.org/en-US/firefox/addon/stardown/" target="_blank">
Install Stardown from Add-ons for Firefox</a>
Expand All @@ -142,20 +157,20 @@ function installWithStore(instructions) {
}

function installWithZip(instructions) {
if (isChromium) {
if (chromiumEl.checked) {
instructions.steps.push(
// TODO: link to the zip file of the built code
`<a href="">Click here to download the .zip file</a>`,
`<a href="https://github.com/Stardown-app/Stardown/releases/latest" target="_blank">
Download the chrome.zip file</a>`,
'Unzip the .zip file',
'In your browser, open <code>chrome://extensions/</code>',
'Turn on developer mode',
'Click "Load unpacked"',
'Select the unzipped copy of Stardown',
);
} else if (isFirefox) {
} else if (firefoxEl.checked) {
instructions.steps.push(
// TODO: link to the zip file of the built code
`<a href="">Click here to download the .zip file</a>`,
`<a href="https://github.com/Stardown-app/Stardown/releases/latest" target="_blank">
Download the firefox.zip file</a>`,
'Unzip the .zip file',
'In your browser, open <code>about:debugging#/runtime/this-firefox</code>',
'Click "Load Temporary Add-on..."',
Expand Down Expand Up @@ -190,15 +205,15 @@ function installWithTerminal(instructions) {
&& cd Stardown</code>`
);

if (isChromium) {
if (chromiumEl.checked) {
instructions.steps.push(
'Then run <code>npm install && npm run build-chrome</code>',
'In your browser, open <code>chrome://extensions/</code>',
'Turn on developer mode',
'Click "Load unpacked"',
'Select Stardown\'s <code>chrome</code> folder',
);
} else if (isFirefox) {
} else if (firefoxEl.checked) {
instructions.steps.push(
'Then run <code>npm install && npm run build-firefox</code>',
'In your browser, open <code>about:debugging#/runtime/this-firefox</code>',
Expand All @@ -211,12 +226,12 @@ function installWithTerminal(instructions) {
}

function updateWithStore(instructions) {
if (isChromium) {
if (chromiumEl.checked) {
instructions.text = `
You're up to date! Extensions installed from the store update
automatically.
`;
} else if (isFirefox) {
} else if (firefoxEl.checked) {
instructions.text = `
Extensions installed from the store normally update automatically. If
you might have automatic updates turned off, see
Expand All @@ -229,20 +244,20 @@ function updateWithStore(instructions) {
}

function updateWithZip(instructions) {
if (isChromium) {
if (chromiumEl.checked) {
instructions.steps.push(
// TODO: link to the zip file of the built code
`<a href="">Click here to download a new .zip file</a>`,
`<a href="https://github.com/Stardown-app/Stardown/releases/latest" target="_blank">
Download a new chrome.zip file</a>`,
'Unzip the .zip file',
'In your browser, open <code>chrome://extensions/</code>',
'Remove Stardown',
'Click "Load unpacked"',
'Select the newly unzipped copy of Stardown',
);
} else if (isFirefox) {
} else if (firefoxEl.checked) {
instructions.steps.push(
// TODO: link to the zip file of the built code
`<a href="">Click here to download a new .zip file</a>`,
`<a href="https://github.com/Stardown-app/Stardown/releases/latest" target="_blank">
Download a new firefox.zip file</a>`,
'Unzip the .zip file',
'In your browser, open <code>about:debugging#/runtime/this-firefox</code>',
'Remove Stardown',
Expand All @@ -255,14 +270,14 @@ function updateWithZip(instructions) {
}

function updateWithTerminal(instructions) {
if (isChromium) {
if (chromiumEl.checked) {
instructions.steps.push(
'In a terminal, navigate into Stardown\'s folder',
'Run <code>git pull && npm install && npm run build-chrome</code>',
'In your browser, open <code>chrome://extensions/</code>',
'Click Stardown\'s reload button',
);
} else if (isFirefox) {
} else if (firefoxEl.checked) {
instructions.steps.push(
'In a terminal, navigate into Stardown\'s folder',
'Run <code>git pull && npm install && npm run build-firefox</code>',
Expand Down

0 comments on commit fa179a2

Please sign in to comment.