Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 3.79 KB

installation-instructions.md

File metadata and controls

67 lines (39 loc) · 3.79 KB
layout category subtitle topic date tags
article
article
Exocore
10 may 22

Exocore Installation Instructions

Launch your Exocore

1. Join Github

If you don't have a Github account, create one here. Git provides the ability to edit your project locally, and push it to the web to be deployed as a website. Remember to hide your email in Settings > Emails > Keep my email addresses private.

2. Launch your Exocore

Launch your Exocore instance on Netlify in a few minutes by clicking here. Netlify offers free hosting for your Exocore, and builds your site server-side with Jekyll. Sign up with your Github account, and follow the instructions to create a new Git repository (project) from this template. You'll end up on a 'Site Overview' page from which you can customize your domain name (in domain settings).

Your Exocore is now live! Read on to find out how to edit it on your local machine.

Local Exocore setup

3. Clone your new repository to your device

Now that you have signed up with Github and published your template Exocore, the easiest way to get the repository onto your device is to use the Github desktop app. You can also use the command line tool, but the GUI is friendlier for new users. You can download it here.

Open the program and follow the instructions to sign in to your Github account, then find the repository you just created and click 'clone (your-username/repository-name)'. Select a place you want the repository to live (such as your desktop) and click 'Clone'. This downloads a copy of your Exocore onto your machine so that your changes will by synchronized.

4. Edit and publish your Exocore from VSCode

First, download [VSCode]](https://code.visualstudio.com/). It's a program you can use to write posts in your Exocore with the help of some handy [exocore#Full Tech Stack|recommended extensions], which you will be prompted to install when you open the Exocore.

After downloading, open your newly forked repository in VSCode by clicking file > Open, and navigating to your Exocore's top-level directory.

The Netlify extension that you will be prompted to install can be used to publish your site without leaving VSCode. To set it up, navigate to the extension's settings via the icon in the bottom left corner, find the extension's settings, and paste your Netlify site ID into the relevant box. Your site ID can be found in Site settings > General > Site details in Netlify.

To publish from VSCode, head to the 'Source Control' tab in the sidebar and click the checkmark icon to commit your changes and write a commit message. Then, click the ellipsis and hit 'Push'. You will see a message in the bottom info bar about your Netlify deploy.


You're done! Your Exocore is now ready to be edited locally. You can learn about how to create new posts [start-here#Creating new posts|here], or get familiar with Exocore syntax [syntax|here]. To get familiar, it's recommended that you read some of the articles which demonstrate some of the Exocore's features, and particularly that you read them on your local device alongside the published website to see how to best take advantage of your website.