Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gustavohenrique/taghub

All repositories that I starred in GitHub since 2009 organized by tags
https://github.com/gustavohenrique/taghub

github golang quasar-framework sqlite vuejs

Last synced: about 2 months ago
JSON representation

All repositories that I starred in GitHub since 2009 organized by tags

Host: GitHub
URL: https://github.com/gustavohenrique/taghub
Owner: gustavohenrique
License: apache-2.0
Created: 2020-03-27T01:10:53.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-03-07T03:12:09.000Z (almost 2 years ago)
Last Synced: 2024-04-16T03:18:25.346Z (9 months ago)
Topics: github, golang, quasar-framework, sqlite, vuejs
Language: Go
Homepage: https://taghub.gustavohenrique.com
Size: 6.59 MB
Stars: 1
Watchers: 1
Forks: 2
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![TagHub](resources/logo.png)](https://taghub.gustavohenrique.com)
-----

[![forthebadge](https://forthebadge.com/images/badges/made-with-go.svg)](https://golang.org)
[![forthebadge](https://forthebadge.com/images/badges/made-with-vue.svg)](https://quasar.dev)
[![forthebadge](https://forthebadge.com/images/badges/contains-technical-debt.svg)]()

[![Build Status](https://travis-ci.com/gustavohenrique/taghub.svg?branch=master)](https://travis-ci.com/gustavohenrique/taghub)
[![Coverage Status](https://coveralls.io/repos/github/gustavohenrique/taghub/badge.svg?branch=master)](https://coveralls.io/github/gustavohenrique/taghub?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/gustavohenrique/taghub)](https://goreportcard.com/report/github.com/gustavohenrique/taghub)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=CLK3RJCCUNSR2&currency_code=USD&source=url)

[![demo](resources/demo.gif)](https://taghub.gustavohenrique.com)

# TagHub

TagHub gets all repositories that I starred in GitHub since 2009 and allows me to add tags for them.

## Table of content

- [Getting Started](#getting-started)
- [Usage](#usage)
- [Architecture](#architecture)
- [Contrib](#contrib)
- [License](#license)

## Getting Started

First, ensure that you have Go >= 1.14, NodeJS >= 10.16 and make utility.
Then, create a [GitHub Personal Token](https://github.com/settings/tokens/new) and
add the token in `.makerc` file like this:

```sh
cd backend
echo "GITHUB_PERSONAL_TOKEN=" > .makerc
```

## Usage

Running the back-end:

```sh
cd backend
make run
```

Open another terminal instance, install the Quasar Framework and run the front-end:

```sh
cd frontend
npm i -g @quasar/cli
npm run serve
```

Now, you can open the front-end:

```sh
open http://localhost:15234 # or xdg-open in Linux systems
```

Also, you can generate a static version and deploy it to GitHub Pages, Netlify, AWS S3 etc.

```sh
cd backend
make json
cd ../site
npm run build
cd dist/spa
open index.html
```

## Architecture

There are 3 applications inside this mono repository:

- **backend**: Rest API written in Go.
- **frontend**: Admin interface using VueJS + Quasar Framework to manage tags and repositories.
- **site**: Static site that fetchs JSON files instead to Rest API.

### Backend

#### Directories

```sh
.
├── build # automation scripts
├── cmd # exports repos and tags from database to JSON files
├── libs # private libs
│   ├── configuration # config based on environment variables
│   ├── errors # add custom code used by HTTP response
│   ├── filter # mount an SQL Where statement based in some rules sent in POST request
│   ├── httpclient # FastHTTP implementation used by the GitHub client
│   ├── github # get starred repos from GitHub using v4 API as Rest client instead of GraphQL
│   ├── logger # Logrus implementation
│   ├── stringutils # some code to deal with strings
│   └── testutils # help to write tests
├── pkg # store the application version according of the branch name
├── sql # database schema and initial data used in tests
└── src # the application source code
├── containers # containers used for dependency injection
├── domain # structs and interfaces
├── handlers # routes and endpoints using Echo Framework
├── http # HTTP server
├── sqlite # run SQL queries
└── services # business logic and data transformation
```

#### Layers

- **handlers**: Rest API, the application's entrypoint, receive, validate and convert requests to structs. It looks like a orchestrator, forwarding the data to the service layer.
- **services**: Apply business roles and prepare the data before to send to the repository layer.
- **repositories**: Consume the SQLite database.

### Frontend

```sh
.
└── src
├── assets # files compiled by Webpack
├── boot # register components and libs like Axios
├── components # Vue components
├── css # custom CSS rules
├── layouts # the top-level components
├── pages # components rendered by routes
├── router # mapping routes to pages
├── services # get and send data to back-end
└── statics # images, favicon etc.
```

### Site

```sh
.
└── src
├── assets
├── boot
├── components
├── css
├── layouts
├── pages
├── router
├── services
└── statics
└── jsonfiles # several JSON files generated by make json command
```

## Contrib

1. Open an issue asking for your new feature or bug fix.
2. Fork this repo and send a Pull Request.
3. Please don't be lazy as I and write some tests for you code.

## License

Apache License 2.0, see [LICENSE](LICENSE).