Code Monkey home page Code Monkey logo

github-api-mono's Introduction

API Company Monorepo

API monorepo is a api monorepo in go to access github api.

Development

Use docker-compose docker-compose to run the code.

devmode consist of auto refresh when you save your go code

apply environment variable

don't forget to add GITHUB_ACCESS_TOKEN in docker-compose

cd api
export GITHUB_ACCESS_TOKEN=<your-token>
export $(egrep -v '^#' ./github-api/.env | xargs)
docker-compose build
docker-compose up -d

PG Admin

Can be access in localhost:5050

Credential can be seen in

/api/github-api/.env

# Used by pgadmin service 
PGADMIN_DEFAULT_EMAIL=test@test
PGADMIN_DEFAULT_PASSWORD=password

# Postgres Test
DB_HOST=postgres_test                      
DB_HOST=db                     # when running the app without docker 
DB_USER=marc
DB_PASSWORD=password
DB_NAME=github
DB_PORT=5432

to see the code running execute these commands

cd 
docker-compose logs -f

Testing in Go

Use this test your go

    cd api/github-api
    go test 

Documentation of a package

   cd api/github-api
   go docs

Usage

Deployment

for the deployment for the api I use helm script to template the deployment

for each api folder contains manifest folder where your content for deployment are and use CI/CD tools to deploy your application

cd api/github-api
helm install manifest 

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

github-api-mono's People

Contributors

marcpar 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.