architecture_decision_record
docker-flask-example
architecture_decision_record | docker-flask-example | |
---|---|---|
22 | 31 | |
11,264 | 553 | |
- | - | |
7.7 | 7.8 | |
3 days ago | about 1 month ago | |
Python | ||
- | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
architecture_decision_record
-
Ask HN: How to Translate Markdown Repositories?
I'm translating the Architecture Decision Record project to more languages. I'm seeking advice and guidance please: how are you all managing translations of git repos of content such as documentation and markdown files?
My experiments so far are here:
https://github.com/sixarm/locale-help
My work-in-progress is to create a top level directory `./locales`, then subdirectories per language using a ISO 639-1 two-letter language code, then content directories, for example:
./locales/en/hello/ (this is in English)
./locales/es/hola/ (this is in Español a.k.a. Spanish)
What do you use to track which content directories correspond to each other across languages?
The Architecture Decision Record repo is now mostly auto-translated into Spanish, French, Welsh, and Korean, in the top level directory `./locales`, using the program `slug-case` to help translate the markdown content file headlines into directory names:
https://github.com/joelparkerhenderson/architecture-decision-record
-
Show HN: Architecture Decision Record – Spanish Tranlsations
Link is https://github.com/joelparkerhenderson/architecture-decision...
-
Architecture diagrams enable better conversations
Hi, article author here, we supplement our architecture diagrams with Architectural Decision Records (ADRs) https://github.com/joelparkerhenderson/architecture-decision... in the ADR we capture:
-
Documenting your decisions using the ADR approach
Architecture decision record by joelparkerhenderson
-
Polar v1.0: Let’s Fix Open Source Funding
If anyone wants to see Polar in action on a GitHub issue, I'm experimenting with Polar on my Architecture Decision Record repo:
https://github.com/joelparkerhenderson/architecture-decision...
(I'm on the fence about the value of Polar for this kind of issue... see what you think)
-
How did you acquire confidence in system design?
This method is only slightly formalized as ADR (architecture decision record). What I personally like about templates that people share on the interned (https://github.com/joelparkerhenderson/architecture-decision-record) it that if force designed to actually consider cons of selected approach or honestly attempt to analyze alternatives.
-
A practical overview on Architecture Decision Records (ADR)
The GitHub repo joelparkerhenderson/architecture-decision-record is a good source to get an overview of tools, articles and examples.
-
Ask HN: How to do Git successors, in case of death?
GitHub is prompting me to add a git successor to my open source repo, in case I die.
Do people here have advice about how to do this, or experience in doing it?
Any brainstorms about how to do it across all the related repos, orgs, etc., such as a will, or well-known file in the repo, that donates to a nonprofit, or foundation, etc.?
Here's the repo:
https://github.com/joelparkerhenderson/architecture-decision-record
-
A Simple Framework for Architectural Decisions
Architecture Decision Records are a big help for teamwork. I have a bunch of notes and examples here, including from my time at ThoughtWorks with technology radars.
https://github.com/joelparkerhenderson/architecture-decision...
-
Documenting agreements
If you want to get started with ADR, I recommend looking at the repository, where you can find different ADR templates and examples of how to use them.
docker-flask-example
-
We Have to Talk About Flask
I've been maintaining my Build a SAAS App with Flask video course[0] for 8 years. It has gone from pre-1.0 to 2.3 and has been recorded twice with tons of incremental updates added over the years to keep things current.
In my opinion tutorial creators should pin their versions so that anyone taking the course or going through the tutorial will have a working version that matches the video or written material.
I'm all for keeping things up to date and do update things every few months but rolling updates don't tend to work well for tutorials because sometimes a minor version requires a code change or covering new concepts. As a tutorial consumer it's frustrating when the content doesn't match the source code unless it's nothing but a version bump.
I've held off upgrading Flask to 3.0 and Python 3.12 due to these open issues with 3rd party dependencies https://github.com/nickjj/docker-flask-example/issues/17.
[0]: https://buildasaasappwithflask.com/
-
Working with Docker Containers Made Easy with the Dexec Bash Script
I usually end up with project specific "run" scripts which are just shell scripts so I can do things like `./run shell` to drop into the shell of a container, or `./run rails db:migrate` to run a command in a container.
Here's a few project specific examples. They all have similar run scripts:
- https://github.com/nickjj/docker-flask-example
- Looking to use Docker & Docker Compose in production and need advice.
-
Docker Compose Examples
There's a lot of "tool" selections in that repo.
If anyone is looking for ready to go web app examples aimed at both development and production, I maintain:
- https://github.com/nickjj/docker-flask-example
-
starter project?
Personally I maintain https://github.com/nickjj/docker-flask-example. There's also https://github.com/nickjj/build-a-saas-app-with-flask if you want more opinions.
-
Act: Run your GitHub Actions locally
This is what I do except I use a shell script instead of a Makefile.
A working example of this is at: https://github.com/nickjj/docker-flask-example/blob/912388f3...
Those ./run ci:XXX commands are in: https://github.com/nickjj/docker-flask-example/blob/912388f3...
I like it because if CI ever happens to be down I can still run that shell script locally.
- docker-compose file repository?
-
How boring should your team be
> I've encountered a code written in the 12factor style of using environment variables for configuration, and in that particular case there was no validation nor documentation of the configuration options. Is this typical?
I don't know about typical, it comes down to how your team values the code they write.
You can have a .env.example file commit to version control which explains every option in as much or as little detail as you'd like. For my own personal projects, I tend to document this file like this https://github.com/nickjj/docker-flask-example/blob/main/.en....
-
The Unreasonable Effectiveness of Makefiles
I did this for a while but make isn't well suited for this use case. What I end up doing is have a shell script with a bunch of functions in it. Functions automatically becomes a callable a command (with a way to make private functions if you want) with pretty much no boiler plate.
The benefit of this is it's just shell scripting so you can use shell features like $@ to pass args to another command or easily source and deal with env vars.
I've written about this process at https://nickjanetakis.com/blog/replacing-make-with-a-shell-s... and an example file is here https://github.com/nickjj/docker-flask-example/blob/main/run.
-
Flask boilerplate project recommendation?
There's: https://github.com/nickjj/docker-flask-example
What are some alternatives?
backstage - Backstage is an open platform for building developer portals
mangum - AWS Lambda support for ASGI applications
oasis-core - Performant and Confidentiality-Preserving Smart Contracts + Blockchains
build-a-saas-app-with-flask - Learn how to build a production ready web app with Flask and Docker.
danger-js - ⚠️ Stop saying "you forgot to …" in code review
earthly - Super simple build framework with fast, repeatable builds and an instantly familiar syntax – like Dockerfile and Makefile had a baby.
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
full-stack-fastapi-template - Full stack, modern web application template. Using FastAPI, React, SQLModel, PostgreSQL, Docker, GitHub Actions, automatic HTTPS and more.
rfcs - Specifications for Interledger and related protocols
postgres-and-redis - 🗄 PostgreSQL + Redis. Self-Hosted. Docker + Traefik + HTTPS.
architecture-decision
cookiecutter-flask - A flask template with Bootstrap, asset bundling+minification with webpack, starter templates, and registration/authentication. For use with cookiecutter.