A Go module datastore and proxy
Clone or download
voutasaurus and arschles Document trying proxy outside the GOPATH (#797)
* Document trying proxy outside the GOPATH

* document setting GO111MODULE in bash/powershell
Latest commit 7b65736 Oct 19, 2018
Permalink
Failed to load latest commit information.
.github Changing the PR template (#743) Oct 10, 2018
charts/proxy Add jaeger tracer to helm charts (#768) Oct 16, 2018
cmd Implement storage.Backend for S3 storage (#750) Oct 16, 2018
docs Document trying proxy outside the GOPATH (#797) Oct 18, 2018
pkg Fix skipped mongo and minio tests (#791) Oct 18, 2018
scripts Fix skipped mongo and minio tests (#791) Oct 18, 2018
vendor Refactor storage tests (#727) Oct 4, 2018
.dockerignore Cleanup Dockerfiles (#437) Aug 13, 2018
.gitattributes normalize all line endings for the repo (#269) Jul 14, 2018
.gitignore Plumb config - Latest (#627) Sep 11, 2018
.goreleaser.yml change go releaser to create draft releases (#621) Sep 2, 2018
.travis.yml Fix skipped mongo and minio tests (#791) Oct 18, 2018
CODE_OF_CONDUCT.md Add Code of Conduct (#707) Oct 3, 2018
CONTRIBUTING.md add how to claim an issue (#669) Sep 18, 2018
DEVELOPMENT.md Update the DEVELOPMENT.md file. Add a warning that docker-compose -p … Oct 3, 2018
LICENSE Updating the license author (#387) Aug 3, 2018
Makefile Remove redis from make as we can use in-memory queue for development (#… Oct 18, 2018
PHILOSOPHY.md Update PHILOSOPHY.md (#582) Aug 28, 2018
README.md Docs: Added "makeapullrequest.com" links (#754) Oct 8, 2018
REVIEWS.md Adding comments on when to use each review type (#661) Sep 28, 2018
SHOULDERS.md use buffalo/shoulders to generate SHOULDERS.md (#479) Aug 16, 2018
config.dev.toml Implement storage.Backend for S3 storage (#750) Oct 16, 2018
docker-compose.yml Add datadog to docker-compose as well (#758) Oct 11, 2018
go.mod Add stackdriver to traces (#737) Oct 4, 2018
go.sum Tracing Exporter for Datadog #714 (#723) Oct 4, 2018
init.ps1 Proxy remove assets and config scripts (#693) Sep 21, 2018
netlify.toml redirect other domain requests to docs.gomods.io (#663) Sep 14, 2018

README.md

Welcome To Athens, Gophers!

Athens Banner

Open Source Helpers Build Status codecov GoDoc Go Report Card PRs Welcome

Welcome to the Athens project! We're building all things Go package repository in here.

  1. Package Registry
  2. Edge Proxy

See our documentation site https://docs.gomods.io for more details on the project.

Project Status

Project Athens is in a very early alpha release and everything might change. Don't run it in production, but do play around with it and contribute when you can!

More Details Please!

Although the project is in development, here's where we're going:

The package registry and the edge proxy both implement the vgo download protocol, but each one is intended for different purposes.

The registry will be hosted globally, and will be "always on" for folks. Anyone will be able to configure their machine to do a go get (right now, it's a vgo get) and have it request packages from the registry.

On the other hand, the registry will only host public code. If you have private code, the edge proxy is your jam. The proxy will store your private code for you, in your database of choice. It will be designed to also cache packages from the registry, subject to an exclude list.

Development

See DEVELOPMENT.md for details on how to set up your development environment and start contributing code.

Speaking of contributing, read on!

Contributing

This project is early and there's plenty of interesting and challenging work to do.

If you find a bug or want to fix a bug, we ❤️ PRs and issues! If you see an issue in the queue that you'd like to work on, please just post a comment saying that you want to work on it. Something like "I want to work on this" is fine.

If you decide to contribute (we hope you do 😄), the process is familiar and easy if you've used Github before. There are no long documents to read or complex setup. If you haven't used Github before, the awesome @bketelsen has created a good overview on how to contribute code - see here.

Before you do start contributing or otherwise getting involved, we want to let you know that we follow a general philosophy in how we work together, and we'd really appreciate you getting familiar with it before you start.

It's not too long and it's ok for you to "skim" it (or even just read the first two sections 😄), just as long as you understand the spirit of who we are and how we work.

Getting Involved

If you're not ready to contribute code yet, there are plenty of other great ways to get involved:

  • Come talk to us in the #athens channel in the Gophers slack. We’re a really friendly group, so come say hi and join us! Ping me (@arschles on slack) in the channel and I’ll give you the lowdown
  • Come to our weekly development meetings! They are a great way to meet folks, ask questions, find some stuff to work on, or just hang out if you want to. Just like with this project, absolutely everyone is welcome to join and participate in those
  • Get familiar with the system. There's lots to read about. Here are some places to start:

Built on the Shoulders of Giants

The Athens project would not be possible without the amazing projects it builds on. Please see SHOULDERS.md to see a list of them.

Coding Guidlines

We all strive to write nice and readable code which can be understood by every person of the team. To achieve that we follow principles described in Brian's talk Code like the Go team.

Code of Conduct

This project follows the Contributor Covenant (English version here) code of conduct.

If you have concerns, notice a code of conduct violation, or otherwise would like to talk about something related to this code of conduct, please reach out to me, Aaron Schlesinger on the Gophers Slack. My username is arschles. Note that in the future, we will be expanding the ways that you can contact us regarding the code of conduct.


Athens banner attributed to Golda Manuel