An application to easily & securely sign Stellar transactions (build)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.well-known
icons
.gitattributes
.nojekyll
AUTHORS
CNAME
LICENSE
README.md
authenticator.css
authenticator.js
authenticator.js.map
browserconfig.xml
cosmic-lib.css
index.html
manifest.json
package-lock.json
stellar-sdk.js
worker.js
worker.js.map

README.md

stellar-authenticator.org website

The website is served directly from the GitHub repository, thanks to CloudFlare CDN. More precisely, what is served is the HEAD of the master branch of the build repository.

You can run this website locally, or run your own fork of the web quite easily.

Run it locally 1 (download)

You can get an archive of the website at:

https://github.com/cosmic-plus/https-stellar-authenticator/archive/master.zip

Some browsers will accept to run index.html directly (like Firefox), some other won't (like Chrome).

Run it locally 2 (git, npm & live-server)

If you have git and npm, you can serve the website localy:

git clone https://github.com/cosmic-plus/https-stellar-authenticator
cd https-stellar-authenticator
npm install --global live-server
live-server

The website should be available at http://127.0.0.1:8080.

Serve it on the web

You can serve your own clone of the website on Github simply by forking the https://github.com/cosmic-plus/https-stellar-authenticator repository. Then go to the repository settings and under GitHub Pages select Master as Source. Your clone will be available at:

https://{username}.github.io/{repository}

You can serve it over your own by tweaking the CNAME file and making your domain point to GitHub.

Your fork will get its own storage space in users browser: private keys are properly compartimented.

Tweak it

If you only want to change the way the website display, you can edit the files index.html and main.css of the build repository.

If you want to play with the javascript sources, you need to get them beforehand:

git clone https://github.com/cosmic-plus/webapp-stellar-authenticator
cd webapp-stellar-authenticator
npm install
npm run get
npm run serve

The changes made to the javascripts files into the src/ directory will be pushed to the website automatically. The changes to the html and css files in the src/ directory have to be manually pushed using:

npm build-html
npm build-css

Remember that the source repository contains the build repository as a submodule at web/. All you'll have to do to publish your modified version of the website is to push this submodule to your own GitHub repository.

Build it

To pack the production version:

npm run format
npm run build

Check build integrity

After building and commiting the last version of your changes, run:

npm run check

The git status should show no modified files.