qpage - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #llm #android #docker #macos #awesome #kubernetes #pytorch #security #mcp #open-source

qpage

(★ 98)

👨‍💻 Free Project For Creating Academic Homepage Without Any Code In 3min

File Explorer

Download Latest Version (.zip)

- favicon.ico
- Latin-Lipsum.txt
- params.py
- qpage.py
- setup.py
- test.py
.gitignore
.travis.yml
appveyor.yml
AUTHORS.md
codeclimate-config.patch
coverage.xml
LICENSE
README.md
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/sepandhaghighi/qpage

Downloads the entire project code from GitHub to your computer.

cd qpage

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">

<a href="http://www.qpage.ir"><img src="http://www.qpage.ir/images/logo.png"/></a>
<h2>QPage</h2>
<a href="https://waffle.io/sepandhaghighi/qpage"><img src="https://badge.waffle.io/sepandhaghighi/qpage.png?label=ready&title=Ready"/></a>
<a href="http://www.qpage.ir/doc"><img src="https://img.shields.io/badge/doc-latest-orange.svg"></a>

</div>
<hr/>
<div align="center">

<a href="https://badge.fury.io/py/qpage"><img src="https://badge.fury.io/py/qpage.svg"/></a>
<a href="https://gitter.im/qpage/Lobby?source=orgpage"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=plastic"/></a>
<a href="https://scrutinizer-ci.com/g/sepandhaghighi/qpage/?branch=master"><img src="https://scrutinizer-ci.com/g/sepandhaghighi/qpage/badges/quality-score.png?b=master"/></a>
<a href="https://zenodo.org/badge/latestdoi/43780325"><img src="https://zenodo.org/badge/43780325.svg" alt="DOI"></a>         
<a href="https://www.codacy.com/app/sepand-haghighi/qpage?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=sepandhaghighi/qpage&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/4d3f9b490b9a42c282b745ae8e2a122c"/></a>

</div>

## Overview
QPage or QuickPage is a Free Project For Creating Academic Homepage Without Any Code			
We developed QPage on Windows but it also run in Linux and Mac-OSX.
QPage is written in Python3, in order to run it, you will need a python interpereter.
<div align="center">
<img src="http://www.qpage.ir/images/blockdiagram.jpg" height=400px width=600px alt="qpage blockdigram">
<p>Block Diagram</p>
</div>

## Dependencies

- [Download](https://www.python.org/downloads/) And Install Last Version Of Python ( * or use exe folder and skip this step * )

- [![Requirements Status](https://requires.io/github/sepandhaghighi/qpage/requirements.svg?branch=master)](https://requires.io/github/sepandhaghighi/qpage/requirements/?branch=master)

## Installation
### Source Code
- [Download](https://github.com/sepandhaghighi/qpage/archive/v2.0.zip) QPage

- Just Unzip It !
### PyPI

- Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
- `pip install qpage`

## Usage
<div align="center">

<img src="http://www.qpage.ir/help/qpage.gif" alt="QPage animation" title="Source Code">
<p>Soure Code</p>
<br/>
<img src="http://www.qpage.ir/help/qpage2.gif" alt="QPage animation" title="EXE-FILE">
<p>EXE-File</p>
</div>
- Run setup (for the first use wait to create folders)

- You can download samples and run in test mode (*Optional)
 
- Put your profile picture in image folder (jpg , bmp , tiff , gif , png)

- Put each page details in a text file with page name in doc folder (* In this step you can use [M] , [S] or [L] at the start and [center] at the end of each line to control font size and alignment )

- Put your resume file (pdf format) in doc folder

- Put your font file in font folder (*Optional)

- Put your icon file in image folder (*Optional) suggested site

- Enter your name

- Choose your profile image size

- Choose your text and background color

- You can preview your webpage

- Finished!!! Now you can go and upload output folder contains directly in your host
			
## Automated Build
				
<div align="center">
<table style="border:1px solid black">
<tr>
<th>Linux</th>
<th>Windows</th>

</tr>

<tr>
<td><a href="https://travis-ci.org/sepandhaghighi/qpage"><img src="https://travis-ci.org/sepandhaghighi/qpage.svg?branch=master"></a></td>
<td> <a href="https://ci.appveyor.com/project/sepandhaghighi/qpage"><img src="https://ci.appveyor.com/api/projects/status/7q21ophn5d8p8a2q?svg=true"></a>	</td>

</tr>

</table>

</div>

## Sample Sites
- [Sample 1](http://www.qpage.ir/sample/sample-site1)
- [Sample 2](http://www.qpage.ir/sample/sample-site2)
- [Sample 3](http://ee.sharif.ir/~ghojogh_benyamin/)

## Credits
- Homepage : [Link](http://www.qpage.ir) 
- PyPI : [Link](http://pypi.python.org/pypi/qpage) 
- Staticgen : [Link](http://www.staticgen.com/qpage)
- SourceForge : [Link](https://sourceforge.net/projects/qpage/)  
- OpenHub : [Link](https://www.openhub.net/p/TheQPage)
- Coverage Report : [Link](http://www.qpage.ir/htmlcov/index.html)	
- Code Documents: [Link](http://www.qpage.ir/doc/index.html)
                                                 
## Issues & Bug Reports

Just fill an issue and describe it. I'll check it ASAP!							
or send an email to [report@qpage.ir](mailto:report@qpage.ir "report@qpage.ir").

## TODO

- [ ] Items
  - [x] Font
  - [x] Icon
  - [ ] In-Text Link
  - [ ] In-Text Pic
- [x] Meta-Tags
- [ ] Inline Markup 
- [ ] GUI
- [ ] FTP-Uploader	
- [ ] Template Gen	
- [ ] Javascript
- [ ] Mobile View

## Contribution

You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. ❤️

Remember to write a few tests for your code before sending pull requests.

## Similar Works
- [Statick](https://getstatik.com) Multi-purpose static web site generator aimed at developers
- [Jekyll](http://jekyllrb.com) Transform plain text into static websites and blogs.
- [Hugo](https://github.com/spf13/hugo) A Fast and Modern Static Web Engine
- [Jemdoc](https://github.com/jem/jemdoc) Light text markup for creating websites

## License

<a href="https://github.com/sepandhaghighi/qpage/blob/master/LICENSE"><img src="https://img.shields.io/github/license/mashape/apistatus.svg"/></a>

## Citing

If you use QPage for your project homepage or something like this , please cite this ;-)

<blockquote>
<p>Sepand Haghighi, & Mohammad Mahdi Rahimi. (2017, January 31). QPage - Free Project For Creating Academic Homepage Without Any Code. Zenodo. doi:10.5281/zenodo.265544</p>
</blockquote>

## Donate to our project

<h3>Beerpay :</h3>

Hey dude! Help me out for a couple of :beers:!

[![Beerpay](https://beerpay.io/sepandhaghighi/qpage/badge.svg?style=beer-square)](https://beerpay.io/sepandhaghighi/qpage)  [![Beerpay](https://beerpay.io/sepandhaghighi/qpage/make-wish.svg?style=flat-square)](https://beerpay.io/sepandhaghighi/qpage?focus=wish)

<h3>Bitcoin :</h3>

```1XGr9qbZjBpUQJJSB6WtgBQbDTgrhPLPA```

<h3>Payping (For Iranian citizens) :</h3>

<a href="http://www.payping.net/sepandhaghighi" target="__blank"><img src="http://www.qpage.ir/images/payping.png" height=100px width=100px></a>