Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.75 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.75 KB

Nexus Github Pages Starter Kit

Nexus is a peer-to-peer Micro Social Network.
This is the Nexus GitHub Pages Starter Kit repository.

GitHub Pages are public webpages hosted and published through GitHub.
They are available to free accounts!

Getting started

If do not have a GitHub account, start by creating one: github.com/signup.

Click the Fork button to create a copy of this Starter Kit on your account.
Go to the Settings tab.

  • in Options: rename Nexus-Github-starter to nexus
  • in Pages: select main as branch and root as folder, then click Save.

Upload your media files in media/ if any.

If you're unfamiliar with Git, you can add new files through the GitHub website:

  • in your Nexus repository, navigate to the folder where you want to place files
  • click the Add file button
  • select your file(s)
  • click Commit changes.

You can also use the GitHub desktop application: desktop.github.com.

Launch the Editor: https://your-github-handle.github.io/nexus/?edit and fill in the form.
Click ⇣ to download your new .json file.
In your repository, replace source/nexus.json with your updated Nexus .json file.

Access your Nexus: https://your-github-handle.github.io/nexus/.

More detailed documentation is available here: nexus-dock.github.io

Other resources

GitHub Pages Documentation: docs.github.com/en/pages

Nexus Code repository: I-is-as-I-does/Nexus
Apache Starter Kit: I-is-as-I-does/Nexus-Apache-starter