Merge pull request #919 from julian-molina/plugins-docs
Contribution: README
This commit is contained in:
1 file changed
+35
-8
@@ -1,14 +1,26 @@
|
||||
# Superalgos Beta 9 - Getting Started Guide
|
||||
# Superalgos Beta 9
|
||||
|
||||
All procedures are the same for Windows, Linux, or Mac OS. Raspberry Pi terminal commands have been included for ease of use.
|
||||
Superalgos is not just another open-source project. We are an open community devised, nurtured, and incentivized with the project's native Superalgos (SA) token to grow into a massive trading collaboration. You will notice the difference as soon as you join the [Telegram Community Group](https://t.me/superalgoscommunity) of the new [Discord Server](https://discord.gg/CGeKC6WQQb).
|
||||
|
||||
> **IMPORTANT:** Minimalist hardware —both virtual and physical— is better suited for production deployments, where the use of the GUI is minimal. We highly recommend learning Superalgos in a local installation. Mastering the system takes time, and the use of the GIU to go through in-app tutorials is crucial during the learning process. Your experience will be orders of magnitude better if you follow this advice: leave minimalist hardware for when you are ready to start trading live.
|
||||
We are building the ultimate market research and trading automation platform to compete in the markets on a level playing field.
|
||||
|
||||
The Superalgos software is contributor-centric, built by contributors, for contributors. It is also free and open-source.
|
||||
|
||||
> Can't wait to start contributing? No need to wait! You may start by giving a star to this repository!
|
||||
|
||||
|
||||
|
||||
# Getting Started Guide
|
||||
|
||||
All procedures are the same for Windows, Linux, or Mac OS. Raspberry Pi terminal commands have been included for ease of use.
|
||||
|
||||
> **IMPORTANT:** Remote installations and minimalist hardware —both virtual and physical— are better suited for production deployments, where the use of the GUI is minimal. We highly recommend learning Superalgos in a local installation. Mastering the system takes time, and the use of the GIU to go through in-app tutorials is crucial during the learning process. Your experience will be orders of magnitude better if you follow this advice: leave remote installations and minimalist hardware for when you are ready to start trading live.
|
||||
|
||||
|
||||
|
||||
# Pre-Requisites
|
||||
|
||||
## 1. Node JS
|
||||
## 1. Node JS Installation
|
||||
|
||||
If you don't have it yet, download and install Node.js.
|
||||
|
||||
@@ -18,9 +30,17 @@ Node JS is an open-source server environment required to run Superalgos.
|
||||
|
||||
**b.** Download your system’s installer. Select *LTS Recommended for Most Users* and click the big Windows or macOS Installer button. If you are on Linux, the installer is listed further down the page.
|
||||
|
||||
**c.** Run the installer with the default configuration — just click Next until Node.JS is fully installed.
|
||||
**c.** Run the installer with the default configuration — just click Next until Node.JS is fully installed.
|
||||
|
||||
**NOTE FOR RASPBERRY PI USERS:** You may install Node.JS just like you would on any other machine as per the above instructions. As an alternative, you may also try the following from the SSH Terminal. **NOTE:** It is best to use the most current and updated version of the FULL PiOS image.
|
||||
> That's it! You can continue with step 2 (Git Installation).
|
||||
|
||||
<hr>
|
||||
|
||||
**NODE JS INSTALLATION FOR RASPBERRY PI USERS**
|
||||
|
||||
You may install Node.JS just like you would on any other machine as per the above instructions. As an alternative, you may also try the following from the SSH Terminal.
|
||||
|
||||
**NOTE:** It is best to use the most current and updated version of the FULL PiOS image.
|
||||
|
||||
```
|
||||
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
|
||||
@@ -37,8 +57,9 @@ you may also type the following to verify the Node.js installation and version.
|
||||
```
|
||||
node -v
|
||||
```
|
||||
<hr>
|
||||
|
||||
## 2. Git
|
||||
## 2. Git Installation
|
||||
|
||||
Download and install Git.
|
||||
|
||||
@@ -54,11 +75,17 @@ Git is an open-source distributed version control system required to download an
|
||||
|
||||
**NOTE FOR MAC USERS:** Depending on your setup, installing Git may be optional. The native XCode Command Line Developer Tools seems to work well. If you do install Git, we have tested Tim Harper's binary installer successfully.
|
||||
|
||||
**NOTE FOR RASPBERRY PI USERS:** Just like with Node.JS, you may follow the above instructions to install Git, or us the SSH Terminal command. The most recent version of PiOS has Git already installed, so this may give you an error. The error will not affect your installation.
|
||||
<hr>
|
||||
|
||||
**GIT INSTALLATION FOR RASPBERRY PI USERS**
|
||||
|
||||
Just like with Node.JS, you may follow the above instructions to install Git, or use the SSH Terminal command. The most recent version of PiOS has Git already installed, so this may give you an error. The error will not affect your installation.
|
||||
```
|
||||
sudo apt-get install git
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
## 3. Google Chrome or Safari
|
||||
|
||||
Use Chrome, or Safari on Mac. These are the only tested browsers.
|
||||
|
||||
Reference in new issue
Block a user