From 23d8c9c030f17598215c23a450bf6f21e08e7644 Mon Sep 17 00:00:00 2001 From: harsh jain Date: Tue, 3 Apr 2018 14:16:29 +0530 Subject: [PATCH 1/2] Update (README.md): Add link to /api/v1 for api discription. (#53) --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c6c181f7..6de06a62 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ The Open Event Orga Server can be easily deployed on a variety of platforms. Det One-click Heroku deployment is also available: -[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fossasia/open-event-legacy) [![Deploy to Docker Cloud](https://files.cloud.docker.com/images/deploy-to-dockercloud.svg)](https://cloud.docker.com/stack/deploy/?repo=https://github.com/fossasia/open-event-legacy) +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/fossasia/open-event-legacy) [![Deploy to Docker Cloud](https://files.cloud.docker.com/images/deploy-to-dockercloud.svg)](https://cloud.docker.com/stack/deploy/?repo=https://github.com/fossasia/open-event-legacy) ## Technology Stack @@ -266,6 +266,9 @@ The tentative release policy for now is, (since there is a lot of activity and a * Test the application on your machine and explore the admin area. The test deployment on Heroku will not give you access to the admin section, where you can switch on/off modules, e.g. ticketing and add keys for services, e.g. storage on S3. * If you would like to work on an issue, drop in a comment at the issue. If it is already assigned to someone, but there is no sign of any work being done, please free to drop in a comment so that the issue can be assigned to you if the previous assignee has dropped it entirely. +** Route Documentation ** +- Information about the endpoints of api is available by using swagger at `/api/v1` endpoint. For quick reference, you can also refer [https://eventyay.com/api/v1/](https://eventyay.com/api/v1/). + ## License This project is currently licensed under the GNU General Public License v3. A copy of LICENSE.md should be present along with the source code. To obtain the software under a different license, please contact [FOSSASIA](http://blog.fossasia.org/contact/). From 15462b9dd9974430ac7245440a3c2d491ba29281 Mon Sep 17 00:00:00 2001 From: bhaveshAn Date: Fri, 25 May 2018 14:45:30 +0530 Subject: [PATCH 2/2] Fixes #63 Install deps and run app through Virtual Environment --- .gitignore | 2 ++ docs/installation/local.md | 11 +++++++++++ 2 files changed, 13 insertions(+) diff --git a/.gitignore b/.gitignore index f2b7e423..27e8338e 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,8 @@ test.db app.db .idea/ .bundle/ +venv/ +.venv # Static files at 'app/static/vendor' app/static/vendor diff --git a/docs/installation/local.md b/docs/installation/local.md index e95896bd..b3c59efd 100644 --- a/docs/installation/local.md +++ b/docs/installation/local.md @@ -42,9 +42,20 @@ cd open-event-legacy * **Step 1** - Install python requirements. You need to be present into the root directoryt of the project. +Installing the dependencies System Wide + ```sh sudo -H pip install -r requirements.txt ``` + +Installing and Running through Virtual Environment + +```sh +virtualenv venv +source venv/bin/activate +pip install -r requirements.txt +``` + hint: You may need to upgrade your pip version and install following packages if you encounter errors while installing the requirements. ```sh sudo apt-get install python-dev