Welcome to the open repository, documentation and materials for the Samvera Connect 2018 Library Data APIs Bootcamp!
- When: Tuesday, October 9th, 2018, 9:00 - 5:00
- Where: J. Willard Marriott Library, University of Utah
- Workshop Materials: github.com/PenguinParadigm/samvera18apis
- Workshop Slides: in Google Drive
A growing number of people are seeing the need to evolve library data systems to a data-forward microservices architecture. But, how to get there? This bootcamp gives an overview of a data API & service example, going from design to development to deployment. It’s not meant to be an in-depth dive of every topic therein, but link these domains and topics together. We hope that participants would then leave with more comfort on how to start separating out services and data needs for an evolution to clear RESTful APIs and scalable microservices.
[free space where you can throw in any other buzzwords you'd like to see. Plus another reminder that we won't be doing a deep dive of each topic, but an accelerated walk through of an existing project and process from some recent work.]
This bootcamp is a registration-only workshop as part of Samvera Connect 2018. If you have questions about the workshop specifically, you can contact the workshop leaders using the information below.
| Time | Topic | Link(s) |
|---|---|---|
| 9-9:30 | Introduction, Logistics, Goals | N/A (just follow slides) |
| 9:30-10:15 | Designing our API (ReST, PCDM, OAS) | Design.md |
| 10:15-10:30 | break | |
| 10:30-12 | Developing our API (Go, Go-Swagger, Localstack) | Develop.md |
| 12-14:00 | Lunch Break (on your own) | |
| 14:00-14:45 | Deploying our API (Docker) | |
| 14:45-15 | break | |
| 15:00-16:30 | Deploying our API (AWS) | |
| 16:30-17 | Conclusion & Workshop Retrospective |
To keep this workshop a happy, safe and inclusive space, we ask that you review and follow the Recurse Center Social Rules (aka Hacker School Rules).
We also ask that you come willing to take part and help out where you may have expertise to share!
We request that all participants bring a laptop with internet connection & modern web browser. On that laptop, please already have:
- installed the latest, stable version (18.06.1-ce) of Docker Community Edition;
- installed latest, stable version (1.11) of Go & set up your Go workspace.
- Mac/homebrew users may want to install Go with homebrew, as it is a dependency of software installed in the workshop via brew.
- our workshop GitHub repository on your computer (with mechanism to update / pull down latest changes on Tuesday morning).
mkdir -p $GOPATH/src/github.com/PenguinParadigmcd $GOPATH/src/github.com/PenguinParadigmgit clone https://github.com/PenguinParadigm/samvera18apis.git
- set up a free AWS account & awscli connected to that free account.
- pulled down & can run this localstack docker image for use in your Go workspace.
- installed jq
If you're short on time or other needs, you need at least Go, localstack, and docker for following along with local development. We will use our lunch break to help folks catch up or debug these installation requirements as we are able, though the morning requires Go be set up.
If you have any issues with the above, please contact us ASAP using the communication methods detailed below.
If you have questions or concerns leading up to or after the bootcamp, please ask in the #taco-workshop channel on the Samvera Slack or open an issue on this GitHub repository, particularly with any questions dealing with workshop preparation or any installation issues. This allows multiple workshop leaders to respond as able, and other participants can also learn.
- Join our #taco-workshop Samvera Slack channel. (Don't have an account? Sign up!)
- Open an issue here (free Github account required)
During the workshop, we will indicate the best ways to get help or communicate a question/comment - however, this bootcamp is intended to be informal, so feel free to speak up or indicate you have a question at any time.