Commit be3a20c0dea922cec4191907b93f3f3f3fb14074
- README.md 43 ----------+++++++++++++++++++++++++++++++++
- Diff rendering mode:
- inline
- side by side
README.md
| 49 | using these APIs, provided they have a valid access token. | 49 | using these APIs, provided they have a valid access token. |
|---|---|---|---|
| 50 | 50 | ||
| 51 | 51 | ||
| 52 | |||
| 53 | 52 | Pre-requisites | |
| 53 | -------------- | ||
| 54 | 54 | ||
| 55 | The swtstore application is written in Python and uses a relational database. | 55 | The swtstore application is written in Python and uses a relational database. |
| 56 | 56 | ||
| … | … | ||
| 62 | For more information on supported databases see | 62 | For more information on supported databases see |
| 63 | [here](http://docs.sqlalchemy.org/en/rel_0_9/dialects/index.html). | 63 | [here](http://docs.sqlalchemy.org/en/rel_0_9/dialects/index.html). |
| 64 | 64 | ||
| 65 | |||
| 66 | 65 | Also, make sure you have [pip](https://pip.pypa.io/en/latest/) installed, as | |
| 66 | swtstore depends of few external python packages. | ||
| 67 | 67 | ||
| 68 | **NOTE: Make sure you have the pre-requisites installed before following the | ||
| 69 | installation steps.** | ||
| 70 | |||
| 71 | |||
| 72 | Installing | ||
| 73 | ---------- | ||
| 74 | |||
| 68 | * Clone the repository from [https://git.pantoto.org/sweet-web/sweet-web-engine](https://git.pantoto.org/sweet-web/sweet-web-engine) | 75 | * Clone the repository from [https://git.pantoto.org/sweet-web/sweet-web-engine](https://git.pantoto.org/sweet-web/sweet-web-engine) |
| 69 | |||
| 70 | |||
| 71 | 76 | ||
| 72 | 77 | > $ git clone --recursive https://git.pantoto.org/sweet-web/sweet-web-engine.git | |
| 78 | |||
| 79 | If you have already cloned the repo, and then reading this README, you have | ||
| 80 | to get the submodules. Run this from the top-level of this repo: | ||
| 81 | |||
| 82 | > $ git submodule init | ||
| 83 | > $ git submodule update | ||
| 84 | |||
| 85 | |||
| 86 | * It is recommended to do the installation inside a python virtual | ||
| 87 | environment. | ||
| 88 | For deploying on a server, it depends on how you have setup your server | ||
| 89 | environment. | ||
| 73 | If you think, you know what you are doing and don't need the virtual | 90 | If you think, you know what you are doing and don't need the virtual |
| 74 | 91 | environment, you can skip to the next step. | |
| 92 | |||
| 75 | Initialize a python virtual environment using `virtualenv` in the same directory | 93 | Initialize a python virtual environment using `virtualenv` in the same directory |
| 76 | where you cloned the repository in the above step. Now, activate the | 94 | where you cloned the repository in the above step. Now, activate the |
| 77 | environment | 95 | environment |
| … | … | ||
| 100 | 100 | ||
| 101 | * Run the setup.py script to install `` python setup.py install `` | 101 | * Run the setup.py script to install `` python setup.py install `` |
| 102 | 102 | ||
| 103 | |||
| 104 | 103 | ||
| 104 | You're done with the installation step. | ||
| 105 | 105 | ||
| 106 | Now you need to configure swtstore to run it correctly. | ||
| 107 | |||
| 108 | |||
| 106 | Configure swtstore | 109 | Configure swtstore |
| 107 | ------------------ | 110 | ------------------ |
| 108 | 111 | ||
| 112 | * Make sure you have configured the user management module with correct values. | ||
| 113 | |||
| 109 | * Copy the contents of ``sample_config.py`` inside the ``swtstore`` directory | 114 | * Copy the contents of ``sample_config.py`` inside the ``swtstore`` directory |
| 110 | into ``config.py`` inside ``swtstore`` directory itself. | 115 | into ``config.py`` inside ``swtstore`` directory itself. |
| 111 | 116 | ||
| 112 | 117 | Assuming you are using a \*-nix based system, and you are in the root directory | |
| 113 | of the codebase, | 118 | of the codebase, |
| 114 | 119 | ||
| 115 | `` $ cp swtstore/sample_config.py swtstore/config.py`` | 120 | `` $ cp swtstore/sample_config.py swtstore/config.py`` |
