Skip to content

Commit

Permalink
Changed font of about page to Monaco, updated readme, about
Browse files Browse the repository at this point in the history
  • Loading branch information
amitt001 committed Aug 13, 2018
1 parent 01d8669 commit 55e39b2
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 31 deletions.
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ LABEL vendor="Amit Tripathi"
RUN apt update -y && apt install python3-pip -y

WORKDIR /pygmy
ADD . /pygmy
ADD ./requirements.txt /pygmy/requirements.txt
RUN pip3 install -r requirements.txt
ADD . /pygmy

EXPOSE 8000

Expand Down
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,38 @@

# Pygmy


[![Build Status](https://travis-ci.org/amitt001/pygmy.svg?branch=master)](https://travis-ci.org/amitt001/pygmy)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/Django.svg)
[![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/)

Live version of this project @ [https://pygy.co](https://pygy.co)

Check link stats by adding **+** to the URL. Example [pygy.co/pygmy+](https://pygy.co/pygmy+)

*Note that pygy.co is a demo website for this project and should be used as such. While the website is going to be up for the foreseeable future, its future depends on the sponsorship and hosting that I get. Currently, project is hosted on Digitalocean, as they were kind enough to offer me one year of sponsorship. I would like to keep the project website up and maintain the project but I do not make any money out of this project or website.
If you would like to supprt the project, I can be contacted on my email of sources listed on websites contact page.*

# Table of Contents
- [Pygmy](#pygmy)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Technical Info](#technical-info)
- [Installation/Setup](#installationsetup)
- [DB Setup:](#db-setup)
- [Use MySQL](#use-mysql)
- [Use Postgresql](#use-postgresql)
- [Use SQLite](#use-sqlite)
- [Using Pygmy API](#using-pygmy-api)
- [Features](#features)
- [Technical Info](#technical-info)
- [Installation/Setup](#installationsetup)
- [Docker](#docker)
- [Manual(from source)](#manualfrom-source)
- [DB Setup:](#db-setup)
- [Use MySQL](#use-mysql)
- [Use Postgresql](#use-postgresql)
- [Use SQLite](#use-sqlite)
- [Using Pygmy API](#using-pygmy-api)
- [Create User:](#create-user)
- [Shell Usage](#shell-usage)
- [How Link Stats Are Generated?](#how-link-stats-are-generated)
- [How Pygmy Auth Token Works?](#how-pygmy-auth-token-works)
- [Development](#development)
- [Contributions](#contributions)
- [Sponsorship](#sponsorship)
- [License](#license)
- [Shell Usage](#shell-usage)
- [How Link Stats Are Generated?](#how-link-stats-are-generated)
- [How Pygmy Auth Token Works?](#how-pygmy-auth-token-works)
- [Development](#development)
- [Contributions](#contributions)
- [Sponsorship](#sponsorship)
- [License](#license)

Pygmy or `pygy.co` is an open-source, extensible & easy-to-use but powerful URL shortener. It's created keeping in mind that it should be easy to host and run your custom URL shortener without much effort. [Open-source Python URL shortener]

Expand Down Expand Up @@ -62,8 +68,9 @@ The architecture is very loosely coupled which allows custom integrations easily

### Docker

1. `docker run -it -p 8000:8000 amit19/pygmy`
2. Open http://localhost:8000 in your browser
1. In terminal run this command: `docker pull amit19/pygmy`
2. Then run the container: `docker run -it -p 8000:8000 amit19/pygmy`
3. Open http://localhost:8000 in your browser

### Manual(from source)

Expand Down Expand Up @@ -234,6 +241,13 @@ It uses JWT. When user logs in using username and password two tokens are genera

If you find any bug, have a question or a general feature request. Open an issue on the 'Issue' page.

To contribute to project:

1. Clone the repo and make changes
2. Build the code: `docker build pygmy`
3. Test the chnages by running: `docker run -it -p 8000:8000 pygmy`
4. The website will be available at: http://127.0.0.1:8000/

Run tests and generate a coverage report:

`coverage run --source pygmy -m py.test`
Expand Down
4 changes: 2 additions & 2 deletions pygmyui/static/css/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ margin-top: 3%;
}

.big-text {
font-family: Georgia, Times, "Times New Roman", serif;
font-size: 18px;
font-family: Monaco, Georgia, Times, "Times New Roman", serif;
font-size: 12px;
font-style: normal;
font-variant: normal;
line-height: 21px;
Expand Down
19 changes: 14 additions & 5 deletions pygmyui/templates/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ <h1>About</h1>
<div class="big-text">
<h3>Pygmy: Open-source, extensible & easy-to-use URL shortener</h3>
<p>Pygmy is a feature-rich, easy-to-use, extensible and easy to deploy and host url shortener.
It's created keeping in mind that it should be easy to deploy and extend.</p>
The project's aim is to make URL shortener easy for anyone to deploy and extend.
This project is not supposed to be an alternative of existing URL shorteners like bitly.
</p>
<h3>Major Features:</h3>
<ul>
<li>Custom URL</li>
Expand All @@ -16,7 +18,7 @@ <h3>Major Features:</h3>
<li>User dashboard</li>
<li>Link Analytics(add + to the tiny URL to get link stats)</li>
</ul>
<p>This is one of the most powerful, feature-rich open-source URL shortener available.
<p>This is one of the most powerful and feature-rich open-source URL shortener available.
The architecture is very loosely coupled which allows custom integrations very easily.</p>
<h3>The project has 3 major parts:</h3>
<ol>
Expand All @@ -25,12 +27,19 @@ <h3>The project has 3 major parts:</h3>
<li>The UI layer for rendering the UI. It uses Django framework.</li>
</ol>
Each part is independent of other part and it can function independently.
The project is created keeping in mind that each of the parts can be used separately
without any dependency on other part.
The project is created keeping in mind that each of the parts can be used separately without any dependency on the other parts.
<br><br>
<p>
Note that pygy.co is a demo website for <a href="https://github.com/amitt001/pygmy">pygmy</a> project and should be used as such.
While the website is going to be up for the foreseeable future, its future depends on the sponsorship and hosting that I get.
Currently, the project is hosted on Digitalocean, as they were kind enough to offer me one year of sponsorship.
I would like to keep the project website up and maintain the project but I do not make any money out of this project or website.
If you would like to supprt the project, I can be contacted through the below links or contact page.
</p>
</div>
<br>
</div>
<div class="vcenter big-text">
<div class="vcenter big-text" style="font-size: 14px">
<a href="https://twitter.com/amitt0119" target="_blank">Twitter</a>&emsp;
<a href="https://facebook.com/amit.the1" target="_blank" rel="nofollow">Facebook</a>
</div>
Expand Down
6 changes: 3 additions & 3 deletions pygmyui/templates/contact.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
{% block content %}
<div style="margin-top: 14%">
<h1 class="horizontal-center">Contact</h1><br>
<div class="horizontal-center big-text">
<div class="horizontal-center big-text" style="font-size: 18px">
Github: <a href="http://github.com/amitt001" target="_blank">amitt001</a><br><br>
</div>
<div class="horizontal-center big-text">
<div class="horizontal-center big-text" style="font-size: 18px">
Twitter: <a href="https://twitter.com/amitt019" target="_blank">amitt019</a><br><br>
</div>
<div class="horizontal-center big-text">
<div class="horizontal-center big-text" style="font-size: 18px">
Email: mail2amit19 at gmail
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions pygmyui/templates/pygmy/short_url.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ <h1 class="vcenter">Pygmy</h1>
Shorten Another Link
</a>
<div style="margin-top:20%;" class="big-text">
<p class="horizontal-center">Check link stats by adding + to the URL</p>
<a href="{{short_url}}+" target="_blank">{{short_url}}+</a><br><br>
<p class="horizontal-center" style="font-size: 14px">Check link stats by adding + to the URL</p>
<a href="{{short_url}}+" target="_blank" style="font-size: 14px">{{short_url}}+</a><br><br>
</div>
</div>
<script>
Expand Down

0 comments on commit 55e39b2

Please sign in to comment.