This is a student project at Denison University that aims to digitalize the tutoring session verification process.
Follow the instructions to download and install the necessary tools to run the app. If at some point, you already have an application installed, you can skip it.
Download Node.js here. Since this is a small project, what version you choose should not matter. At the time of writing this, I am using version 13.9.0. The default options during installation should be good.
After installation, you can check if Node.js is properly installed using command node -v and the output should be the version you just installed.
This is for installing Python and pip, a pack-management system for packages written in Python.
Download Anaconda for Python 3 here. During installation, make sure to choose the option Add Anaconda to my PATH environment variable.
Download git for Windows here if needed. Unix and MacOS users should already have git installed.
Go to the directory you want to clone the project into and type git clone https://github.com/quang2705/ARC.git in the command-line. Then cd ARC and switch to develop branch using git checkout develop.
This is optional. If you skip this section, please use pip install -r requirements.txt to install a python package for this project.
For Windows. Create an environment called ARC for our project using conda create -n ARC. Then activate it with conda activate ARC. From now on, whenever we install a package from pip, it will install it for the ARC environment only instead of global by default. This way we can avoid conflicts between packages.
For MacOS and Unix. Do pip install virtualenv and pip install virtualenvwrapper to install vitualenv and virtualenvwrapper packages. Then python3 -m venv ARC to create environment named ARC. Activate it using source ARC/bin/activate.
In the command-line, type conda install --name ARC django. Then conda install --name ARC djangorestframework. The commands will install those packages in the ARC environment and can only be used if the ARC environment is activated.
Note. If the virtual environment does not work for some reason, use pip install _package_name_ to install the package in the global environment. However, this may create conflicts with packages not used by this project.
Use the following command to install dependencies for our Django project:
pip install oauth2_provider python-social-oauth[django] django-rest-framework-social-oauth2
cd arc_projects/frontend then npm install.
Download the file db.sqlite3 and put it in arc_projects folder. This is the pseudo-database we currently work with for testing purposes.
Optional. To generate a database, delete migrations folder in arc_app and delete db.sqlite3 file in arc_projects. In arc_projects folder, run python manage.py makemigrations arc_app and python manage.py migrate. And finally run python populate_users.py.
Go to arc_projects/frontend, run npm run dev. Use npm run dev -- --watch if you want webpack to monitor file changes without having to re-run the command.
At arc_projects folder while in command-line, use python manage.py runserver to run the server. The address should be listed after "Starting development server at". The default address is http://127.0.0.1:8000.
If encounter issues with django or djangorestframework package not found, use pip install django and pip install djangorestframework instead.
Our team provide a simple but useful api for working with the database, reference and documentation of the API can be found here API documentation
Meg Jaffy - [email protected]
Hiep Phan - [email protected]
Quang Nguyen - [email protected]
Khue Le - [email protected]
Khanh Tran - [email protected]