Taggit is a starred repositories organisation tool for Github. It was built to enable easy tagging and organisation of repositories in your Github stars and allows easy recall for libraries or cool projects you found but forgot the name of.
The project runs on springboot backend core and a VueJS frontend. It can be easily deployed to your favourite cloud provider or via a PAAS.
The project is split into backend and front end.
The backend is written using Kotlin and Spring.
The frontend is written using VueJs and accompanying libraries like Vuex and VueRouter etc.
There are three distinct ways to deploy the app.
- Docker Image
- Docker File
- Jar File
The most up to date docker image can be found in the releases section.
Use that image to deploy or run the app locally.
The project also has the root docker file that can be used to build the app locally.
The whole app can be deployed via the compiled JAR as a monolithic binary i.e. the frontend and the server run from the same Springboot Netty server. This simplifies deployment as you don't have to worry about serving the HTML/CSS/JS assets from elsewhere.
The whole app can be packed by running the following command inside the repo root:
./gradlew stage
This command will build the frontend and the backend and move all the files inside a static directory for backend ay build time.
You will need to set following variables when deploying:
DATABASE_URL=<add your postgres database url here>
DATABASE_USERNAME=<add your database username here>
DATABASE_PASSWORD=<add your database password here>
GITHUB_USERNAME=<add your github username here>
GITHUB_TOKEN=<add your github personal access token here>
APP_PASSWORD=<this the password to get it, adds an extra layer of security when deployed publicly on web>
More information on how to create a github personal access token can be found here
You can run the backend by directly running the main class in the App.kt file or preferably using Docker.
Since we use springboot the easiest way to run backend is to run the following command in the root of the project.
./gradlew :backend:bootRun
For running with Docker ensure you have docker installed, for Mac that can be done via brew:
brew install --cask dockerOnce docker is installed, navigate to the backend folder and run docker compose:
docker-compose upTo run for testing postgres do:
docker-compose --profile test upOnce Postgres is started, create a table named taggit inside your local docker postgres.
Once that is successfully completed, we can fire up the front end.
First navigate into the frontend directory and install all the node modules:
npm installOnce done, fire up the frontend using vue cli:
npm run serveNow you can navigate to http://localhost:3000 on your browser to see the SPA. Please click Sync the first time to have all your repos from github synced.
npm run build
npm run lint