generated from Templates/Docker_Image
Compare commits
3 Commits
2fdbecd3d4
...
0.0.1
| Author | SHA1 | Date | |
|---|---|---|---|
| 44b7f644f8 | |||
| 083fe54605 | |||
| 17cb2aeb24 |
17
HISTORY.md
Normal file
17
HISTORY.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
Changelog
|
||||||
|
=========
|
||||||
|
|
||||||
|
|
||||||
|
(unreleased)
|
||||||
|
------------
|
||||||
|
|
||||||
|
Fix
|
||||||
|
~~~
|
||||||
|
- Second initial commit refs NOISSUE. [Simon Diesenreiter]
|
||||||
|
|
||||||
|
Other
|
||||||
|
~~~~~
|
||||||
|
- Chore: initial commit refs NOISSUE. [Simon Diesenreiter]
|
||||||
|
- Initial commit. [Projects <>]
|
||||||
|
|
||||||
|
|
||||||
32
README.md
32
README.md
@@ -1,36 +1,6 @@
|
|||||||
# Docker Image Project Template
|
|
||||||
|
|
||||||
A low dependency and really simple to start project template for Docker Images.
|
|
||||||
|
|
||||||
Partly based on/see also
|
|
||||||
- [Flask-Project-Template](https://git.disi.dev/Templates/Flask/) for a full feature Flask project including database, API, admin interface, etc.
|
|
||||||
|
|
||||||
### HOW TO USE THIS TEMPLATE
|
|
||||||
|
|
||||||
1. Create a new repository from this template and choose a name for your project
|
|
||||||
(e.g. `my_awesome_project` - recommendation is to use all lowercase and underscores separation for repo names.)
|
|
||||||
2. Wait until the first run of CI finishes (Gitea Actions will process the template and commit to your new repo)
|
|
||||||
3. Read the file [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
||||||
4. Then clone your new project and happy coding!
|
|
||||||
|
|
||||||
> **NOTE**: **WAIT** until first CI run on gitea actions before cloning your new project.
|
|
||||||
|
|
||||||
### What is included on this template?
|
|
||||||
|
|
||||||
- 🖼️ Templates for starting multiple application types:
|
|
||||||
**Run `make init` after cloning to generate a new project based on a template.**
|
|
||||||
- 🤖 A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project.
|
|
||||||
- 💬 Auto generation of change log using **gitchangelog** to keep a HISTORY.md file automatically based on your commit history on every release.
|
|
||||||
- 🐋 A simple [Containerfile](Containerfile) to build a container image for your project.
|
|
||||||
`Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.
|
|
||||||
- 🔄 Continuous integration using [Gitea Actions](.gitea/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments.
|
|
||||||
|
|
||||||
<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -->
|
|
||||||
|
|
||||||
---
|
|
||||||
# project_name
|
# project_name
|
||||||
|
|
||||||
project_description
|
Project description goes here.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|||||||
1
project_name/VERSION
Normal file
1
project_name/VERSION
Normal file
@@ -0,0 +1 @@
|
|||||||
|
0.0.1
|
||||||
Reference in New Issue
Block a user