8000 GitHub - harsh1602/VITask: VITask is an Open Source Dynamic API server for VTOP.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

harsh1602/VITask

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VITask

Still in Development Mode use with caution

VITask is a dynamic API server for VTOP. This repo contains code for Web(Flask server), Android App (React-Native), Desktop (ElectronJS). The code is still i 8473 n development stage, use with caution.

Please make sure you install dependencies before running respective apps. If you are changing code, please read guidelines at the end of this file


Web Application

Prerequisites

You can check the preqrequistes in the VITask Web/requirements.txt file. You require Python 3.2 or higher and make sure pip and python are added in PATH variable successfully before running.

Installation

1.Creating Virtual Environment and activating:

  • Open cmd
  • Change current directory to VITask Web. Using command cd "VITask Web"
  • Run this py -3 -m venv venv or python3 -m venv venv or if you have virtualenv set up use command virtulalenv venv.
  • To activate virtual environment, run this venv\Scripts\activate or if you are using bash terminal source venv/Scripts/activate
  • Now install requirements.txt

2.Installing from requirements.txt:

  • Activate virtual environment as told above.
  • Run this pip install -r requirements.txt

3.Next step is running main.py . But before do following steps.

  • For Windows users, authorize Firebase by saving firebase.json in a suitable location and then executing set GOOGLE_APPLICATION_CREDENTIALS = path_to_your_firebase.json\firebase.json in cmd.
  • For Linux Users, Authorize Firebase by saving firebase.json in a suitable location and then executing export GOOGLE_APPLICATION_CREDENTIALS = path_to_your_firebase.json\firebase.json in terminal.

4.Running main.py

  • Activate virtual environment and then make sure you have completed above steps.
  • Now run py main.py or python main.py or python3 main.py or py3 main.py
  • Open your Browser and then enter URL http://localhost:5000/login to enter your login details
  • Now Check the main.py for the @app.route and then head over to the page you want to check for example if you want to check page xyz then it will have an app route as @app.route('/xyz').Then use the URL http://localhost:5000/xyz

For Desktop and React Native

Dependencies

For installing dependencies, make sure you are inside respective directories. Use command yarn install or npm install to install dependencies from package.json.


Contributing Guidelines

While working on same project please make sure you follow these guidelines.

  • Always update your master branch using git pull origin master.
  • Create seperate branch while working and switch to that branch using git checkout -b branch_name
  • Make changes and commit changes to this branch.
  • Push branch to github using git push -u origin branch_name
  • While working on the branch, be sure to rebase with master to pull in mainline changes:
    git checkout master
    git pull origin master
    git checkout your_branch
    git rebase master
    
  • Approve your Pull requests from GitHub or wait for approval.
  • For more information look into this post.

While working on the project make sure you update and create .gitignore files in the directories if you create some personal and temperoray files.

About

VITask is an Open Source Dynamic API server for VTOP.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 69.7%
  • CSS 19.8%
  • HTML 5.1%
  • JavaScript 3.6%
  • Python 1.5%
  • Objective-C 0.1%
  • Other 0.2%
0