Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upadated readme and added python files learning #88

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -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.
95 changes: 63 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <project_directory_name> # gymkhana_portal
```

```sh
cd <project_directory_name> # 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
```
1 change: 1 addition & 0 deletions temp.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dflka;fjka;mvmclvjao;jfkd
1 change: 1 addition & 0 deletions temp2.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
kla;jf;kajnl;ajd;osfjlkfkla