|Aaron Schlesinger 35799c5f3b Merge branch 'master' into gh-actions||4 months ago|
|.circleci||1 year ago|
|.github||4 months ago|
|.sail||11 months ago|
|charts/athens-proxy||5 months ago|
|cmd/proxy||4 months ago|
|docs||4 months ago|
|e2etests||4 months ago|
|pkg||4 months ago|
|scripts||4 months ago|
|test||4 months ago|
|.dockerignore||8 months ago|
|.drone.yml||4 months ago|
|.gitattributes||2 years ago|
|.gitignore||7 months ago|
|CODE_OF_CONDUCT.md||1 year ago|
|CONTRIBUTING.md||7 months ago|
|DEVELOPMENT.md||7 months ago|
|Dockerfile.test||4 months ago|
|LICENSE||1 year ago|
|Makefile||4 months ago|
|PHILOSOPHY.md||1 year ago|
|README.md||8 months ago|
|REVIEWS.md||1 year ago|
|SHOULDERS.md||1 year ago|
|appveyor.yml||4 months ago|
|azure-pipelines.yml||1 year ago|
|config.dev.toml||4 months ago|
|docker-compose.yml||4 months ago|
|download.example.hcl||1 year ago|
|go.mod||5 months ago|
|go.sum||5 months ago|
|init.ps1||1 year ago|
|netlify.toml||1 year ago|
|robots.txt||9 months ago|
Welcome to the Athens project! We are a proxy server for the Go Modules download API.
|We hold office hours approximately weekly. To find out what they’re all about, join them, watch previous meetings, or just find out more, see the docs. Absolutely everyone is invited to attend these, suggest topics, and participate!|
See our documentation site https://docs.gomods.io for more details on the project.
Project Athens is in beta. It’s being tested and used on teams and has an experimental deployment for public use.
The proxy implements the Go modules download protocol.
There is currently an experimental public proxy (at https://athens.azurefd.net) that you can use to try out Athens, without installing anything locally. We also have a community of folks using Athens in production inside their organizations as an internal proxy. In either deployment, developers set their
GOPROXY environment variable to point to the Athens proxy of their choice. At that point,
go build, and more commands will use the proxy to download dependencies as necessary.
Athens proxies are highly configurable, so they can work for lots of different deployments. For example, proxies support a wide variety of storage drivers including:
See DEVELOPMENT.md for details on how to set up your development environment and start contributing code.
Speaking of contributing, read on!
This project has plenty of interesting and challenging work to do and a wonderful community.
If you find a bug or want to fix a bug, we :heart: 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 :smile:), 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 getting involved or contributing, 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 :smile:), just as long as you understand the spirit of who we are and how we work.
If you’re not ready to contribute code yet, there are plenty of other great ways to get involved:
#athenschannel in the Gophers slack. We’re a really friendly group, so come say hi and join us! Ping me (
@arschleson slack) in the channel and I’ll give you the lowdown
goCLI uses to download packages
The Athens project would not be possible without the amazing projects it builds on. Please see SHOULDERS.md to see a list of them.
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.
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
@arschles on the Gophers Slack.
Athens banner attributed to Golda Manuel