Code Monkey home page Code Monkey logo

botlink's Introduction

shortlink

Shortlink service

PkgGoDev codecov Go Report Card Releases LICENSE CII Best Practices


High Level Architecture 🚀

shortlink-arhitecture

Architecture (miro.com)

Architecture decision records] (ADR)

An architecture decision record (ADR) is a document that captures an important architecture decision made along with its context and consequences.

Services
Service Description Language/Framework Docs
landing Welcome page JS/JQuery
docs Example blog Hugo https://batazor.github.io/shortlink/
next UI service JS/NextJS docs
api GateWay Go docs
link Link service Go docs
newsletter Newsletter service Rust
proxy Proxy service for redirect to original URL TypeScript
bot Telegram bot JAVA
billing Billing service Go
logger Logger service Go
metadata Parser site by API Go
notify Send notify to smtp, slack, telegram Go
shortctl Shortlink CLI Go docs
csi CSI example Go
ory/kratos User management service Go docs
ory/hydra OAuth 2.0 Provider Go docs
shortdb Custom database Go docs

Run

DETAILS

Require
Install GIT sub-repository
git submodule update --init --recursive
docker-compose
For run
make run
For down
make down
Kubernetes (1.19+)
For run
make minikube-up
make helm-shortlink-up
For down
make minikube-down
Skaffold (link)
For run
make skaffold-init
make skaffold-up
For down
make skaffold-down
Debug mode
make skaffold-debug

HTTP API

arhitecture.json

Support HTTP REST API:
  • HTTP (chi)
  • gRPC-gateway
  • GraphQL
  • Optional

MQ

OpenTracing

http_add_link

Cloud-Native

Gateway

  • Traefik
  • Nginx

UI

ENV for UI

Use .env file in ui/[next/etc] directories for setting your UI

Name Default Description
NODE_ENV - Select: production, development, etc...
SENTRY_DSN - Your sentry DSN

UI Screenshot

Describe Screenshot
Link Table link table

Mobile

  • Hello World on flutter ;-)

Configuration

DETAILS

View ENV Variables

CoreDNS IP table

Service Ip address Description
store 10.5.0.100 Main database (postgres/mongo/cassandra/redis)
troubleshooting

Sometimes a container without a specified ip may occupy a binding address of another service, which will result in Address already in use.

Ansible

DETAILS

Vagrant
cd ops/vagrant
vagrant up

cd ops/ansible
ansible-playbook playbooks/playbook.yml
DNS/HTTP
  • ui-next.shortlink.vagrant:8081

CI/CD

-- THE END --

botlink's People

Contributors

aaaaaxfda-zz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.