KanjiWebEasy

Website made to users learn how to read NHK Web Easy articles

Setup for Windows

Download Github for Windows https://windows.github.com/
Drap and drop https://github.com/SebastienGllmt/KanjiWebEasy.git into the Github for Windows application and place file in the default path
Download Python 3.4 from https://www.python.org/downloads/
Download https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py to some folder
Go to the folder where you placed get-pip.py. Inside the folder, shift+right click "open command window here"
Type without quotes: "C:/Python34/python.exe get-pip.py"
Go to C:\Python34\Scripts and shift+right click "open command window here"
Type without quotes: "pip install virtualenv"
Go to My Documents/Github/KanjiWebEasy
Once in the folder, Shift+Right click and select "Open command window here"
Type without quotes: "C:\Python34\Scripts\virtualenv venv"
Go to KanjiWebEasy/venv/scripts or KanjiWebEasy/venv/bin
Once in the folder, Shift+Right click and select "Open command window here"
Type without quotes: "pip install -r ../../requirements.txt"
If you get a missing DLL error, download the Visual C++ redistribution from https://www.microsoft.com/en-us/download/details.aspx?id=48145 (probably x86)
Download Redis 2.8.17 from https://github.com/MSOpenTech/redis/releases
Put the contents of the .zip file in a foler on your C drive called "Redis 2.8.17"

Launching for Windows

Go to the folder where you put Redis then Shift+Right click and select "Open command window here"
Note: You may have to run cmd as an admin, in which case launch cmd as admin and then cd into your Redis directory.
Type without quotes: "redis-server"
Go to KanjiWebEasy/venv/scripts or KanjiWebEasy/venv/bin
Once in the folder, Shift+Right click and select "Open command window here"
Type without quotes: "activate.bat"
Type without quotes: "cd ../.."
Type without quotes: "set PYTHONPATH=."
Type without quotes: "python -m japandb"
Open up your browser of choice and go to http://localhost:5000/

Push a Change

Open up Github for Windows
Select the KanjiWebEasy repository from the list
Sync any changes that may have happened (the sync button is at the top right)
View the list of uncommitted changed (it doesn't appear if you haven't made any changes)
Check which files you want to commit (note, you don't have to pull all your changes in the same commit. You can split them up)
Enter a Summary/Description of the changes and press "Commit to master"
Once all your changes have been made, press Sync again

Note: Your changes will not appear on the live site even after you push a change.

Setup for Linux (Tested on Linux Mint)

Make sure you have the latest packages "sudo apt-get update"
Install all the packages we will need "sudo apt-get install git redis-server python3.4 python3.4-dev python3-pip python-virtualenv"
Clone the repository wherever you want the project "git clone https://github.com/SebastienGllmt/KanjiWebEasy.git" (this step takes a long time)
Navigate into the KanjiWebEasy directory you just cloned "cd KanjiWebEasy"
Setup the virtual environment "virtualenv venv"
Install the project requirements "sudo pip3 install -r requirements.txt"

If you prefer a one line install use this. It will clone the project and set everything up in the current directory.
sudo apt-get update; sudo apt-get install git redis-server python3.4 python3.4-dev python3-pip python-virtualenv; git clone https://github.com/SebastienGllmt/KanjiWebEasy.git; cd KanjiWebEasy; virtualenv venv; sudo pip3 install -r requirements.txt

Launching for Linux (Tested on Linux Mint)