Removed PostgreSQL as a class C dependency, and removed its entry in the readme. Gitar will not feature Postgres-exclusive features in the foreseeable future.
- Author
- Vngngdn
- Date
- Sept. 8, 2016, 7:10 p.m.
- Hash
- 3bbb4c6211f3de0981f2513cc34a21deefcafaf5
- Parent
-
1df9a48f7cdf7c9b80cb0c346167011f9b2baa97
- Modified files
- DEPENDENCIES.md
- README.md
DEPENDENCIES.md ¶
0 additions and 2 deletions.
View changes Hide changes
1 |
1 |
============ |
2 |
2 |
|
3 |
3 |
Since web apps (and everything web related) are known to suck at dependency handling (which is why we have Bower, NPM, cdnjs, docker, ... (I'll explain sometime somewhere why this is done, and why I don't like it), I've decided to take matters in my own hands; I'll just provide one simple markdown file listing all dependencies in human-readable format. I don't care whether this helps or not, but no harm is done, right? |
4 |
4 |
|
5 |
5 |
Legend |
6 |
6 |
------ |
7 |
7 |
|
8 |
8 |
The dependencies themselves have been ranked with a certain grade. I explain what they mean here: |
9 |
9 |
|
10 |
10 |
* A : This dependency is present inside the app. This will be in the form of ready-to-use source code files. As such, they need no further attention. |
11 |
11 |
* B : This dependency is present inside the app. This will be in the form of an archive file (i.e. .tar.gz), OR this needs additional work to function properly. In these cases, I refer to their documentation which will be available at the location of the files. |
12 |
12 |
* C : This dependency does not come with the app. These are often system packages, which often means (if you're on GNU/Linux) you'll have to search for it in your repositories. Their documentation is your last resort for these if it doesn't work as it should. |
13 |
13 |
|
14 |
14 |
I hope I never will, but when it's necessary, I'll add a D grade, for unreadable, egregious bogus software that will give you all horrible kinds of diseases if you dare to work with it, but are indispensable to make the web app function. Just be happy I don't use it yet. (For example, PHP qualifies as D, so praise [our lord and saviour](https://rms.sexy) I write Python.) |
15 |
15 |
|
16 |
16 |
A |
17 |
17 |
- |
18 |
18 |
|
19 |
19 |
B |
20 |
20 |
- |
21 |
21 |
|
22 |
22 |
C |
23 |
23 |
- |
24 |
24 |
* [GitPython](https://github.com/gitpython-developers/GitPython): Provides a |
25 |
25 |
wrapper to ease Git interaction from Python. |
26 |
26 |
* [PostgreSQL](https://postgresql.org): PostgreSQL is (currently) the only |
27 |
- | supported database. |
28 |
- | * [Pygments](http://pygments.org/): Provides the syntax highlighting for source |
29 |
27 |
code. |
30 |
28 |
README.md ¶
0 additions and 8 deletions.
View changes Hide changes
1 |
1 |
===== |
2 |
2 |
|
3 |
3 |
Gitar is a free/libre, gratis, lightweight, easy to deploy web app for storing information about |
4 |
4 |
desired Git repositories for Django powered web servers. |
5 |
5 |
|
6 |
6 |
Name |
7 |
7 |
---- |
8 |
8 |
|
9 |
9 |
Gitar refers to the fact that the software is built for Git repositories, for |
10 |
10 |
use with the [Django web framework](https://djangoproject.com). Django itself |
11 |
11 |
refers to the name of the guitarist [Django |
12 |
12 |
Reinhardt](https://en.wikipedia.org/wiki/Django_Reinhardt). So I found "Gitar" |
13 |
13 |
an awesome name =3 |
14 |
14 |
|
15 |
15 |
About |
16 |
16 |
----- |
17 |
17 |
|
18 |
18 |
Gitar adheres to Django's MVT structure, and was built to allow people to easily |
19 |
19 |
refer to their Git repos, providing readable code in the background, with |
20 |
20 |
templates implementing Google's [Material Design |
21 |
21 |
specifications](https://www.google.com/design/spec). |
22 |
22 |
|
23 |
23 |
Another reason Gitar was meant to happen, is because of Github's rather |
24 |
24 |
hypocritic approach to its own existence; while it hosts an amazing amount of |
25 |
25 |
[free](https://audio-video.gnu.org/video/TEDxGE2014_Stallman05_LQ.webm) |
26 |
26 |
software, GitHub Inc. does not share GitHub's code at all ([I'm not the only one |
27 |
27 |
that dislikes this](https://github.com/dear-github/dear-github)). Gitar tries to |
28 |
28 |
fix that (and hopefully more). |
29 |
29 |
|
30 |
30 |
Gitar's repo handling consists mainly of read-only features, but I hope I can |
31 |
31 |
expand Gitar in such a way, that it becomes a viable alternative to Github's |
32 |
32 |
offerings. |
33 |
33 |
|
34 |
34 |
Gitar was also made because I wanted to make a serious project with a punny name =) |
35 |
35 |
|
36 |
36 |
Features |
37 |
37 |
-------- |
38 |
38 |
|
39 |
39 |
* Simple and lightweight |
40 |
40 |
* Source code syntax highlighting using Pygments |
41 |
41 |
* No JavaScript required |
42 |
42 |
* Free/Libre software |
43 |
43 |
|
44 |
44 |
Supported databases |
45 |
- | ---------------- |
46 |
- | |
47 |
- | Currently, Gitar only supports PostgreSQL databases. However, the parts that |
48 |
- | make it a Postgres-exclusive program are extremely small, allowing for easy |
49 |
- | refactoring of the code, in order to support other databases. If enough people |
50 |
- | ask for extended database support, I'll be happy to normalize the database in |
51 |
- | order to allow for less cool options like MySQL. |
52 |
- | |
53 |
- | Licensing |
54 |
45 |
--------- |
55 |
46 |
|
56 |
47 |
Gitar is free software, licensed under the GNU Affero General Public License |
57 |
48 |
v3+. |
58 |
49 |