Commit 25ceedc7912b3b586c723c12fcc336f4c7a0f291
1 parent
efd0af87b3
Exists in
master
Removed semanlear :(
Showing 1 changed file with 10 additions and 10 deletions Inline Diff
README.md
View file @
25ceedc
| # Flashy | 1 | 1 | # Flashy | |
| 2 | 2 | |||
| Flashy is a realtime collaborative flashcard sharing app combined with a spaced-repetition study system. Flashy was developed by CSE 110 students in spring quarter 2015: | 3 | 3 | Flashy is a realtime collaborative flashcard sharing app combined with a spaced-repetition study system. Flashy was developed by CSE 110 students in spring quarter 2015: | |
| 4 | 4 | |||
| - lhawkins - Laura Hawkins | 5 | 5 | - lhawkins | |
| - ckwang - Chung Kang Wang | 6 | 6 | - ckwang | |
| - arnog - Arno Gau | 7 | 7 | - arnog | |
| - abuss - Andrew Buss | 8 | 8 | - abuss | |
| - rray - Rohan Rangray | 9 | 9 | - rray | |
| - rlee - Rachel Lee | 10 | 10 | - rlee | |
| - mjeng - Melody Jeng | 11 | 11 | - mjeng | |
| - kmach - Kevin Mach | 12 | 12 | - kmach | |
| - mrahman - Masud Rahman | 13 | 13 | - mrahman | |
| - namtran - Phuong Tran | 14 | 14 | - namtran | |
| 15 | 15 | |||
| Flashy's code is divided among the flashy-backend repository (this one!) and the flashy-frontend repository. When running the local server, these repositories should be sibling directories and the flashy-frontend repository must be cloned into a directory of the same name. | 16 | 16 | Flashy's code is divided among the flashy-backend repository (this one!) and the flashy-frontend repository. When running the local server, these repositories should be sibling directories and the flashy-frontend repository must be cloned into a directory of the same name. | |
| 17 | 17 | |||
| Flashy officially supports Ubuntu 14.04 with at least 2 GB of RAM. A VM is acceptable but performance may be impaired. | 18 | 18 | Flashy officially supports Ubuntu 14.04 with at least 2 GB of RAM. A VM is acceptable but performance may be impaired. | |
| 19 | 19 | |||
| ## Installing Flashy on Ubuntu 14.04 (development/testing) | 20 | 20 | ## Installing Flashy on Ubuntu 14.04 (development/testing) | |
| 21 | 21 | |||
| We recommend installing Flashy on a fresh installation of Ubuntu 14.04. Before installing, make sure all packages are up to date: | 22 | 22 | We recommend installing Flashy on a fresh installation of Ubuntu 14.04. Before installing, make sure all packages are up to date: | |
| 23 | 23 | |||
| sudo apt-get update | 24 | 24 | sudo apt-get update | |
| sudo apt-get upgrade | 25 | 25 | sudo apt-get upgrade | |
| 26 | 26 | |||
| It is important that Python 3 *not* be installed, as this causes issues when creating the virtualenv. | 27 | 27 | It is important that Python 3 *not* be installed, as this causes issues when creating the virtualenv. | |
| 28 | 28 | |||
| ### Install required packages | 29 | 29 | ### Install required packages | |
| 30 | 30 | |||
| sudo apt-get install python-virtualenv redis-server git python-dev | 31 | 31 | sudo apt-get install python-virtualenv redis-server git python-dev | |
| 32 | 32 | |||
| ### Start Redis | 33 | 33 | ### Start Redis | |
| 34 | 34 | |||
| sudo service redis_6379 start | 35 | 35 | sudo service redis_6379 start | |
| echo PING | redis-cli | 36 | 36 | echo PING | redis-cli | |
| 37 | 37 | |||
| Redis should respond PONG to the last command. | 38 | 38 | Redis should respond PONG to the last command. | |
| 39 | 39 | |||
| ### Prepare installation directory | 40 | 40 | ### Prepare installation directory | |
| 41 | 41 | |||
| mkdir ~/flashy/ | 42 | 42 | mkdir ~/flashy/ | |
| cd ~/flashy/ | 43 | 43 | cd ~/flashy/ | |
| 44 | 44 | |||
| ### Retrieve source | 45 | 45 | ### Retrieve source | |
| 46 | 46 | |||
| Clone the two repositories. Provide credentials in each case. | 47 | 47 | Clone the two repositories. Provide credentials in each case. | |
| 48 | 48 | |||
| git clone https://git.ucsd.edu/110swag/flashy-frontend.git | 49 | 49 | git clone https://git.ucsd.edu/110swag/flashy-frontend.git | |
| git clone https://git.ucsd.edu/110swag/flashy-backend.git | 50 | 50 | git clone https://git.ucsd.edu/110swag/flashy-backend.git | |
| 51 | 51 | |||
| ### Prepare backend environment | 52 | 52 | ### Prepare backend environment | |
| 53 | 53 | |||
| When running the setup script, gevent may take a while to install and throw several compiler warnings. These are expected. | 54 | 54 | When running the setup script, gevent may take a while to install and throw several compiler warnings. These are expected. | |
| 55 | 55 | |||
| cd flashy-backend | 56 | 56 | cd flashy-backend | |
| scripts/setup.sh | 57 | 57 | scripts/setup.sh | |
| source venv/bin/activate | 58 | 58 | source venv/bin/activate | |
| python manage.py migrate | 59 | 59 | python manage.py migrate | |
| python manage.py loaddata sections | 60 | 60 | python manage.py loaddata sections | |
| 61 | 61 | |||
| ### Run backend server | 62 | 62 | ### Run backend server | |
| 63 | 63 | |||
| scripts/run_local.sh | 64 | 64 | scripts/run_local.sh | |
| 65 | 65 | |||
| You should be able to access the application at http://127.0.0.1:8080/app/ | 66 | 66 | You should be able to access the application at http://127.0.0.1:8080/app/ | |
| 67 | 67 |