diff --git a/README.md b/README.md index 65a738e934374de5e3829aa22ba6adebe0e25813..e0a3c00ed981019ab3c269b14f3e16c559ca4bd1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Group 10 Habit Tracker Web App ### How to run it? +#### Docker: 1. Make sure docker is installed 2. Clone the repository 3. cd into root repository @@ -9,3 +10,9 @@ [](https://gitlab.eps.surrey.ac.uk/group-10/habit-tracker-web-app/-/wikis/uploads/1b0c612ebe165e45fe7f0c071e55bfe3/image.png "docker-compose up") 6. Access the website on localhost:3000 or 127.0.0.1:3000. 7. For some machines (especially when using Windows) site might be running on another ip, to find it run `docker-machine ip default` + +NOTE: This process was tested on Docker for Windows and might change depending on your platform. +#### Alternatively (rails server): + Run as normal rails application with `bundle install` and `rails server` +#### Alternatively (visit deployed version): +[Use this link to access our site on Heroku](hthttps://group-ten-habits-deployment.herokuapp.com/#_=_tp:// "Use this link to access our site on Heroku")