Overmind: Config to start and end everything (#410)

Install tmux and overmind and copy the `.overmind.env.example` file to
`overmind.env` and copy the `Procfile.dev.example` to `Procfile.dev`
then adjust the location of your frontend repo in the Procfile. Default
assumes that the frontend repo is located in the same folder as the
backend repo. For ex: Change `cd ../dwellingly-app` to `cd
../your_relative_location` or use an absolute path.

Start all servers with `overmind start`. You can connect to any server
in the terminal with `overmind connect name_of_process`.
for ex: `overmind connect frontend` or `overmind connect backend`

This will start a development frontend and backend server. And start a
testing backend and frontend server.

Simplifies start up and removes the need to set config to specify which
server to start.

Author: NickSchimek

.gitignore

@@ -4,6 +4,10 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# overmind config
+.overmind.env
+Procfile.dev
+
 # C extensions
 *.so
 

.overmind.env.example

@@ -0,0 +1 @@
+OVERMIND_PROCFILE=Procfile.dev

CONTRIBUTING.md

@@ -98,7 +98,7 @@ NOTE: Default development database is SQLite3. (Optionally setup and use [Postgr
 
 8. Start the server using the flask environment (required every time the project is re-opened):
    - Run: `pipenv run flask run`
-   - Run and restart the server on changes: `pipenv run flask run --reload`
+   - Optional: Use overmind to start frontend and backend servers with `overmind run start`: See [Starting servers with Overmind](#Starting-servers-with-Overmind)
 9. Test the server and view coverage reports. Use of coverage reporting is recommended to indicate test suite completeness and to locate defunct code in the code base.
    - Run all the tests: `pipenv run pytest --cov .`
      - Run tests in a particular directory: `pipenv run pytest --cov [path to directory]`
@@ -177,6 +177,27 @@ If the above steps don't work and give you an error about either not being able
 
 Everything should be golden now, and running the `pipenv` commands from above should work.
 
+### Starting servers with Overmind
+
+You can start both frontend and backend servers with one command if you have overmind installed.</br>
+Visit [https://github.com/DarthSim/overmind#installation](https://github.com/DarthSim/overmind#installation) for installation instructions.
+copy both `overmind.env.example` and `Procfile.dev.example` to configure overmind.
+
+Run: `cp .overmind.env.example .overmind.env && cp Procfile.dev.example Procfile.dev`
+In your `Procfile.env` file change the location of the frontend repo if its different than the default. The default assumes the frontend repo is located in the same directory as the backend repo.
+
+Then you can start all servers with `overmind start`.
+
+This will start two backend servers and two frontend servers. one dev server and one test server (for system testing) for each repo.
+
+For backend:
+ - The dev server is on port 5000
+ - The test server is on port 5010
+
+For Frontend:
+- The dev server is on port 3000
+- The test server is on port 3010
+
 ### Note For Windows Users
 
 Python does not come by default for Windows users. Sometimes the PATH variable in Windows will point to the wrong path and you will have trouble running the `python` and `pipenv` commands. If you don't have Python installed then follow these steps. If the steps listed above did not work for you, try the following.

Procfile.dev.example

@@ -0,0 +1,4 @@
+backend: export FLASK_ENV=development && pipenv run flask run -p 5000
+backend_testing: export FLASK_ENV=testing && pipenv run flask run -p 5010 --reload
+frontend: cd ../dwellingly-app && PORT=3000 npm run start
+frontend_testing: cd ../dwellingly-app && export REACT_APP_PROXY=http://localhost:5010 && npm run startTest