The project is build on materialize css and simple javascript, you dont need to download libraries specific for the project, you just need apache2.
-
Apache2: Go onto this link How to install Apache2 or follow the instructions below.
--
sudo apt-get update && sudo apt-get upgrade--
sudo apt-get install apache2 apache2-doc apache2-utils--
sudo service apache2 restart
After completeing the setup go onto your browser and type localhost you should be able to see the apache2 welcome page.
After doing that copy and paste the Dashboard folder in /var/www/html/
You can now access UI via localhost/Dashboard
How to setup Database Couchdb
I have used NOSQL couchdb docker image as our database, so you will need to install Docker
Install docker via following command.
-- sudo apt-get update
-- sudo apt-get install docker-ce
After docker is installed run following command.
-- docker run -t --name db -p 8091-8094:8091-8094 -p 11210:11210 couchbase/server-sandbox:5.5.0
This will download and run docker image in data persistance mode.
After the command completes, you can access couchdb from localhost:8091
The initial username is Administrator and password is password
After logging in to the console click on Buckets from side menu this will get you onto the page where you can create buckets (Consider bucket sort of like a table in RDBMS is just no relations) and you can store few different types of data types their including whole python object by pickling it.
Anyway there should be two buckets already available there
- auth (100mb)
- data (412mb)
if they are not create them, auth is the bucket in which we are storing usernames and passwords and data is the one in which we are storing actual data.
After doing that we will need couchbase python dependency. Install it using these commands.
-- wget http://packages.couchbase.com/releases/couchbase-release/couchbase-release-1.0-4-amd64.deb
-- sudo dpkg -i couchbase-release-1.0-4-amd64.deb
-- sudo apt-get update
-- sudo apt-get install libcouchbase-dev build-essential python-dev python-pip
-- sudo pip install couchbase
Link to the documentation of couchbase client
NOTE: If you are creating the Buckets yourself, then run the following code to add username and password to the database for the first time.
-- from couchbase.cluster import Cluster, PasswordAuthenticator
-- cluster = Cluster('couchbase://localhost')
-- cluster.authenticate(PasswordAuthenticator('Administrator', 'password'))
-- bucket = cluster.open_bucket('auth')
-- bucket.upsert('admin', 'admin')
Backend of the project is build on python 2.7, if you are a linux user it comes along with all linux distributions so we don't need to download it specifically, but just in case if you dont have it you can install it by following commands.
-- sudo apt-get update
-- sudo apt-get upgrade
-- sudo apt-get install python2.7 python-pip
Don't upgrade your python-pip to newer version, the newer version is unstable you wont be able to install any python dependencies via pip, but instead you will have to use python-pip command to install dependencies.
To connect Backend API to Frontend we are using Flask, to install full stack of flask dependencies run following commands.
sudo pip install flask
sudo pip install -U flask-cors This will install Flask-Cors.
sudo pip install flask-restful This will install Flask-Restful
You are all set, go into the FlaskProj directory through your terminal and run following command.
python flasktet.py
You should see something like this.
- Serving Flask app "flasktet" (lazy loading)
- Environment: production WARNING: Do not use the development server in a production environment. Use a production WSGI server instead.
- Debug mode: on
- Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
- Restarting with stat
- Debugger is active!
- Debugger PIN: 176-475-588 `