473c2ccb8d
* Removing ElasticSearch Brew instructions If you try to install brew as directed you get this Error: Error: Calling Installation of elasticsearch-oss from a GitHub commit URL is disabled! Use 'brew extract elasticsearch-oss' to stable tap on GitHub instead. Brew/ElasticSearch no longer allows you to tap as we previously have suggested in the doc. Also we can no longer grab the 7.5.2 version with brew. We have decided to remove the instructions for now until we upgrade ElasticSearch if possible. * Adding recommended changes. Added back line 15 per Nicks recommendation (i.e. with rbenv: `rbenv install $(cat .ruby-version)`) Line 65 updated to 7.5 or higher for Elasticsearch per Rhymes recommendation ~Forem requires a version of Elasticsearch 7.5 or higher to be running. We recommend version 7.5.2.~ Line 110 update: Added back in the Homebrew instructions but updated commands to `install elastic/tap/elasticsearch-oss` * Updating wording per Molly's suggestion Updating "to be running " to "run" and adjusting line 64 to "Forem requires Elasticsearch 7.x to run. We recommend version 7.5.2." |
||
|---|---|---|
| .. | ||
| containers.md | ||
| gitpod.md | ||
| imgproxy.md | ||
| linux.md | ||
| mac.md | ||
| others.md | ||
| postgresql.md | ||
| readme.md | ||
| vault.md | ||
| windows.md | ||
| items | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
Installation Guide
There are many different ways you can install the development environment so you can help contribute code to Forem.
Installing locally
You can install Forem to your local machine and we have instructions for Mac, Windows and Linux.
Running with containers
Installing to your local machine can be troublesome for many reasons such as a conflicting database and runtime versions.
Another way you can get a development environment up and running is with containers. They will set up everything you need in an isolated environment, and you need not worry about the details of setting everything up locally. We have instructions for getting set up with containers quickly.
GitPod - beginner friendly!
If you are having trouble with local installation and Docker confuses you, then you can launch a development environment with the press of a button with GitPod.
GitPod is an IDE in the cloud which is also attached to a web server. It will install everything you need. If you are comfortable doing everything from a web browser, then we have instructions for installing with GitPod as well.