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 in development stage, use with caution.
Please m 8433 ake sure you install dependencies before running respective apps. If you are changing code, please read guidelines at the end of this file
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.
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 venvorpython3 -m venv venvor if you havevirtualenvset up use commandvirtulalenv venv. - To activate virtual environment, run this
venv\Scripts\activateor if you are using bash terminalsource 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.jsonin a suitable location and then executingset GOOGLE_APPLICATION_CREDENTIALS = path_to_your_firebase.json\firebase.jsonin cmd. - For Linux Users, Authorize Firebase by saving
firebase.jsonin a suitable location and then executingexport GOOGLE_APPLICATION_CREDENTIALS = path_to_your_firebase.json\firebase.jsonin terminal.
4.Running main.py
- Activate virtual environment and then make sure you have completed above steps.
- Now run
py main.pyorpython main.pyorpython3 main.pyorpy3 main.py - Open your Browser and then enter URL
http://localhost:5000/loginto enter your login details - Now Check the
main.pyfor the@app.routeand then head over to the page you want to check for example if you want to check pagexyzthen it will have an app route as@app.route('/xyz').Then use the URLhttp://localhost:5000/xyz
For installing dependencies, make sure you are inside respective directories. Use command yarn install or npm install to install dependencies from package.json.
While working on same project please make sure you follow these guidelines.
- Always update your
masterbranch usinggit 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.