Skip to content

Commit a8af146

Browse files
Yorgos Saslisar2rsawseen
Yorgos Saslis
authored andcommitted
Added instructions on using Vagrant
1 parent af3972e commit a8af146

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,19 @@ Before starting, you may want to check Github's guide on [contributing open sour
3030
All translations take place on [Transifex Countly page](transifex.com/projects/p/countly). Please check if your language
3131
is not there, or has a small percentage of translation. Create your account and apply to be a translator.
3232

33+
## Setting up a Development Environment
34+
35+
Whether you want to start working on developing a new plugin, or some feature/ issue on the Countly Server itself, you will need a development environment to test your code on.
36+
37+
_Note: you will need [Vagrant](https://www.vagrantup.com/) and [Virtualbox](https://www.virtualbox.org/wiki/Downloads) installed._
38+
39+
1. Start a VM on your machine, with `vagrant up`.
40+
1. Log into the VM, with `vagrant ssh`
41+
1. Use the standard `countly start` / `countly restart` / etc. commands
42+
1. Logs are available in `/opt/countly/logs`
43+
1. (Optional) You might additionally want to enable the [debugger](https://resources.count.ly/v1.0/docs/debugging).
44+
45+
3346
## Add a badge to your site
3447

3548
If you like Countly, [why not use one of our badges](https://count.ly/brand-assets/) and give a link back to us, so others know about this wonderful platform?

0 commit comments

Comments
 (0)