Commit bba7e8104b27fb99a36b2f7c2ce1ac9dc5bf4609
- Diff rendering mode:
- inline
- side by side
README.md
(23 / 13)
| 54 | 54 | ||
| 55 | 55 | The swtstore application is written in Python and uses a relational database. | |
| 56 | 56 | ||
| 57 | Hence, the dependencies of this application are Python and any relational database | ||
| 58 | supported by SQLAlchemy. | ||
| 57 | Hence, the dependencies of this application are: | ||
| 59 | 58 | ||
| 60 | Most common RDBMS supported by SQLAlchemy are MySQL, Postgresql. | ||
| 59 | * Python 2.7. See [here](https://www.python.org/about/gettingstarted/) | ||
| 60 | for more details on installing Python. | ||
| 61 | 61 | ||
| 62 | For more information on supported databases see | ||
| 63 | [here](http://docs.sqlalchemy.org/en/rel_0_9/dialects/index.html). | ||
| 62 | * any relational database supported by SQLAlchemy. Most common RDBMS | ||
| 63 | supported by SQLAlchemy are MySQL, Postgresql. | ||
| 64 | 64 | ||
| 65 | Also, make sure you have [pip](https://pip.pypa.io/en/latest/) installed, as | ||
| 66 | swtstore depends of few external python packages. | ||
| 65 | For more information on supported databases see | ||
| 66 | [here](http://docs.sqlalchemy.org/en/rel_0_9/dialects/index.html). | ||
| 67 | 67 | ||
| 68 | _Installing and setting up a database like MySQL or Postgresql is out of scope | ||
| 69 | of this document. Please search the Internet to get help about installing and | ||
| 70 | setting up a RDBMS._ | ||
| 71 | |||
| 72 | * Also, make sure you have [pip](https://pip.pypa.io/en/latest/) installed, as | ||
| 73 | swtstore depends of few external python packages. | ||
| 74 | See [here](https://pip.pypa.io/en/latest/) to get more details. | ||
| 75 | |||
| 68 | 76 | **NOTE: Make sure you have the pre-requisites installed before following the | |
| 69 | 77 | installation steps.** | |
| 70 | 78 | ||
| … | … | ||
| 80 | 80 | Installing | |
| 81 | 81 | ---------- | |
| 82 | 82 | ||
| 83 | * Clone the repository from [https://git.pantoto.org/sweet-web/sweet-web-engine](https://git.pantoto.org/sweet-web/sweet-web-engine) | ||
| 83 | * Clone the repository from <https://git.pantoto.org/sweet-web/sweet-web-engine> | ||
| 84 | 84 | ||
| 85 | > $ git clone --recursive https://git.pantoto.org/sweet-web/sweet-web-engine.git | ||
| 85 | > `` $ git clone --recursive https://git.pantoto.org/sweet-web/sweet-web-engine.git `` | ||
| 86 | 86 | ||
| 87 | 87 | If you have already cloned the repo, and then reading this README, you have | |
| 88 | 88 | to get the submodules. Run this from the top-level of this repo: | |
| 89 | 89 | ||
| 90 | > $ git submodule init | ||
| 91 | > $ git submodule update | ||
| 90 | > `` $ git submodule init `` | ||
| 92 | 91 | ||
| 92 | > `` $ git submodule update `` | ||
| 93 | 93 | ||
| 94 | |||
| 94 | 95 | * It is recommended to do the installation inside a python virtual | |
| 95 | 96 | environment. | |
| 96 | 97 | For deploying on a server, it depends on how you have setup your server | |
| … | … | ||
| 126 | 126 | Assuming you are using a \*-nix based system, and you are in the root directory | |
| 127 | 127 | of the codebase, | |
| 128 | 128 | ||
| 129 | `` $ cp swtstore/sample_config.py swtstore/config.py`` | ||
| 129 | > `` $ cp swtstore/sample_config.py swtstore/config.py`` | ||
| 130 | 130 | ||
| 131 | 131 | * Edit the config.py file, and change the values accordingly. | |
| 132 | 132 | ||
| 133 | 133 | * Now, you have to setup the database for the swtstore application. But | |
| 134 | 134 | fortunately, the creation of database and tables have also been scripted, so | |
| 135 | 135 | all you need to do is run the ``dbsetup.py`` script. | |
| 136 | `` $ python dbsetup.py `` | ||
| 136 | |||
| 137 | > `` $ python dbsetup.py `` | ||
| 137 | 138 | ||
| 138 | 139 | **NOTE:** Please remember that all these configuration step is necessary and is | |
| 139 | 140 | required whether you are running the application locally or deploying it on a |
