diff --git a/README.md b/README.md index 95d09f2b10159347eece71399a7e2e907ea3df4f..58ee6882df4e2211d44a2b0a83dd98639d495841 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -hello world \ No newline at end of file +To run this project on mac, +1. Make sure you have the lastest version of python installed. +2. Clone the repo from gitlab into githubDesktop and then open a terminal on VScode or your computer terminal. +3. Run the following commads(creating virtual env) + mkdir venvosx + cd venvosx + virtualenv -p python3 . + source ./bin/activate + cd .. + cd bikeAssistant +4. You also need to install django before running the project + pip install django +5. After djago installation, run the server + python manage.py runserver +6. You will be able to click on the link after that command \ No newline at end of file