Commit e0c6516f authored by Alex Gleason's avatar Alex Gleason

Add local development setup to README

parent f604b18f
......@@ -44,7 +44,19 @@ The repository includes deployment configurations for **Docker and docker-compos
A **stand-alone** installation guide will be provided as soon as possible.
A **Vagrant** configuration is included for development purposes.
## Local development
To get started developing on Gab, you will need to run a version of it locally.
The following instructions assume you are already familiar with using a terminal program.
1. Install [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) if you haven't already.
2. Clone this repository with `git clone https://code.gab.com/gab/social/gab-social.git`
3. Change into the project directory with `cd gab-social`
4. Run `vagrant up` to provision the virtual machine. This will take a while.
5. Finally, run `vagrant ssh -c "cd /vagrant && foreman start"` to start the local web server.
6. Visit http://0.0.0.0:3000 in your web browser to see Gab's splash screen. If it doesn't load, or styling is missing, wait another minute and refresh the page.
7. Log in with the username `admin` and password `administrator`
8. Have fun developing on Gab!
## License
......@@ -56,4 +68,4 @@ This program is free software: you can redistribute it and/or modify it under th
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
\ No newline at end of file
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment