a proud OCTOPI project
{product name}©️ is a digital infrastructure that enables clients to visualize data from Search Engine Marketing(SEM) campaigns at a microscopic level, marrying the business logic of clients together with the data from sales campaigns to help companies align their campaign objectives and methodology with their SEM campaigns.
This project is a private project and further information regarding the specific business logic of {product name}:copyright: can only be obtained by request to the maintainer of this GitHub©️ repository.
Click on the links to read more about the technologies in the respective repositories!
For an in-depth walk-through for setting up an entire project on GCP, it is best to refer back to the Google Cloud Platform (GCP) docs to see how a Django project is set up on GCP and how to configure a GCP project yourself (alternatively, create your own project!).
This tutorial will walk you through on how to configure your own GCP Project with django.
DISCLAIMER AND REITERATION: This GitHub is not meant to teach you how to set up on GCP. Do note that knowledge on how Django is set up on GCP is NOT REQUIRED as the set up has already been taken care of during the configuration of this repository.
This tutorial will walk you through on how to start working on this project with GIT
This tutorial will walk you through on how to use an IDE together with GIT
Alternatively, head over to BuildIT.Io's introduction page for all the things a new developer needs to know.
Lastly, ensure the owner of this project has provided you an organisation email and added you into the project. the email should look something like yourname@organisation.page or yourname@organisation.com. If you do not have this information, the next few instructions will not work for you.
-
Clone this repository into a desired folder
-
Create a virtual environment using your IDE (we recommend strictly following the procedure of your IDE rather than using the in built command line and running
virtualenv new-envto create the virtual environment). Place the location of your environment at the same level where the .gitignore file is. You may also be prompted to use a requirements.txt file to download all necessary packages. This can be found in the \amplifyIo directory. -
Test if your virtual environment has been created successfully by running
For Mac/Linux:
new-env/bin/activateFor Windows:
new-env\Scripts\activateAlways remember to be running from the correct directory where your
new-envis. if successful you should see something similar to below:(new-env) MyComputer\User-19982: $If the activate comd generates the message "Activate.ps1 is not digitally signed. You cannot run this script on the current system, use this cmd
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -
Download Cloud SQL Proxy (we recommend placing this file in the same location as where the Google CLoud SDK Program is kept, although it should not matter since Cloud SQL Proxy can technically run from any directory in the command line)
-
Open and run the Google Cloud SDK.
-
Next, we need to connect to the Google Cloud Server to even begin making edits.
For First Time Users: first time users need to
- get username n pw from owner
- run gcloud auth login on cmd line, a pop out page in yr browser will appear
- login via the above username n pw
After all the above first time users steps are completed, proceed with the steps below
For Window Users:
cloud_sql_proxy.exe --instances="amplifyio-308412:asia-southeast1:amplify-io"=tcp:3307For Mac/Linux Users:
.\cloud_sql_proxy -instances="amplifyio-308412:asia-southeast1:amplify-io"=tcp:3307At times you may try to connect and result in the following error:
Can't connect to MySQL server on '127.0.0.1' (3306)This is completely normal if you already downloaded MySQL or equivalent technologies in your computer as 3306 is usually the main port for servers to listen for calls on. In such cases, just check which ports are open on your computer and substitute 3306 with an available port provided by the computer. Keep this running throughout the development process.
Otherwise you should see this
ready for new connections -
Now, we need to install all the dependencies into the virtual environement you created in 2 if this has not been done. On the terminal, actiavte your environement and run the following command:
pip install -r requirements.txt -
Once all this is done, we can then run django normally. Navigate to the folder with the
manage.pyfile and start a local web server.python manage.py runserverThen, in your browser, proceed to
http://localhost:8000 -
Add an account to use the django admin console (signing in and viewing the databases from the built-in admin page on django)
python manage.py createsuperuserFollow the prompts, then restart your local web server again.
You can now make changes to your django project. Here are some reminders when making changes visible on the local web server.
With django, you need to enter a few standard commands everytime changes are made. This is done by
python manage.py makemigrations
python manage.py makemigrations amplifyIoAPI-or-any-other-project
python manage.py migrate
- Always activate cloud_sql_proxy.exe to write local changes into the remote GCP project
- Stop your local webserver with
Ctrl-Cif you intend to use manage.py to run other functions likecreatesuperuser. - Remember to update your urls.py and settings.py to include any new data models and urls you have built in Django
- Check that you are already in the environment
- For every new property, always start with python manage.py startproject new-property-name on the command line
- After adding the new environment and making the necessary changes on urls and settings, don't forget to do python manage.py makemigrations, python manage.py makemigrations new-property-name and python manage.py migrate to complete bootstrapping
- to check for changes, use python manage.py runserver
- to generate static changes, use python manage.py collectstatic
- finalise changes into GCP by doing gcloud app deploy