diff --git a/LICENSE b/LICENSE index a7f7cef..0fc8f6e 100644 --- a/LICENSE +++ b/LICENSE @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE. Must not be modified. diff --git a/README.md b/README.md index dfa1896..a794b81 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,93 @@ # Gymkhana Portal ![Status active](https://img.shields.io/badge/Status-active%20development-2eb3c1.svg) ![Django 2.1.5](https://img.shields.io/badge/Django-2.1.5-green.svg) ![Python 3.6](https://img.shields.io/badge/Python-3.6-blue.svg) + [![Build Status](https://travis-ci.org/devlup-labs/gymkhana_portal.svg?branch=master)](https://travis-ci.org/devlup-labs/gymkhana_portal) -## Web portal and forum for Students' Gymkhana of IIT Jodhpur + +## Web portal and forum for Students' Gymkhana of IIT Jodhpur created by Saurabh Kumar + ### Purpose + Simplify the workflow of updating the gymkhana website without much knowledge on how to code. And also provide certain utility features. This project includes: + - A main `web portal` which can be updated dynamically through an admin interface. - A `forum/discussion` app for general purpose discussions. - An app called `Konnekt` to find/search people with a certain required skill set. + ### Installation: + Requirements: + - Python 3.6 runtime - Django >= 2.1.6 - Other dependencies in `Pipfile` Procedure: + - Install [python](https://www.python.org/downloads/) in your environment(pre-installed on Ubuntu). + - Navigate to the cloned repository. - ``` - cd # gymkhana_portal - ``` + +```sh +cd # gymkhana_portal +``` + - Install `pipenv` for dependency management - ``` - pip install pipenv - ``` + +```sh +pip install pipenv +``` + - Copy `.env.example` to `.env` - ``` - cp .env.example .env - ``` + +```sh +cp .env.example .env +``` + - Use pipenv to install other dependencies from `Pipfile` - ``` - pipenv install --dev - ``` + +```sh +pipenv install --dev +``` + - Activate the new virtual environment - ``` - pipenv shell - ``` + +```sh +pipenv shell +``` + - Change to source code directory - ``` - cd src - ``` + +```text +cd src +``` + - Make database migrations - ``` - python manage.py makemigrations - python manage.py migrate - ``` + +```sh +python manage.py makemigrations +python manage.py migrate +``` + - Create a superuser - ``` - python manage.py createsuperuser - ``` + +```sh +python manage.py createsuperuser +``` + - Download the `static.zip` from `#gymkhana` on [Slack](https://iitjdg.slack.com/) and extract the contents under `src/static` - _Note: This project uses proprietary UI assets, which cannot be shared on GitHub. However you may use free version of [mdbootstrap](https://mdbootstrap.com) as an alternative. Some things may not look as intended._ + *Note: This project uses proprietary UI assets, which cannot be shared on GitHub. However you may use free version of [mdbootstrap](https://mdbootstrap.com) as an alternative. Some things may not look as intended.* + - Run development server on localhost - ``` - python manage.py runserver - ``` -#### DummyData for Testing [OPTIONAL]: -This will populate the database with random values for testing. + +```sh +python manage.py runserver ``` + +#### DummyData for Testing [OPTIONAL]: + +This will populate the database with random values for testing. + +```sh python manage.py createfixture ``` diff --git a/temp.py b/temp.py new file mode 100644 index 0000000..e50ae13 --- /dev/null +++ b/temp.py @@ -0,0 +1 @@ +dflka;fjka;mvmclvjao;jfkd \ No newline at end of file diff --git a/temp2.py b/temp2.py new file mode 100644 index 0000000..8e184ed --- /dev/null +++ b/temp2.py @@ -0,0 +1 @@ +kla;jf;kajnl;ajd;osfjlkfkla \ No newline at end of file