Skip to content

Commit b5105f5

Browse files
ran-isenbergRan Isenberg
and
Ran Isenberg
authored
docs: add cookiecutter (#637)
Co-authored-by: Ran Isenberg <ran.isenberg@ranthebuilder.cloud>
1 parent f378c8a commit b5105f5

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,30 @@ This project can serve as a template for new Serverless services - CDK deploymen
1818
> **Contact details | ran.isenberg@ranthebuilder.cloud**
1919
2020

21+
## Cookiecutter Option
22+
23+
You can get a cleaner version of this repository without using the template button on GitHub with cookiecutter.
24+
25+
* Cookiecutter - install with pip/brew ``brew install cookiecutter`` or ``pip install cookiecutter`
26+
27+
Then run:
28+
29+
```
30+
cookiecutter gh:ran-isenberg/cookiecutter-serverless-python
31+
```
32+
33+
Answer the questions to select repo name, service name, etc.:
34+
35+
![logo](https://github.com/ran-isenberg/cookiecutter-serverless-python/blob/main/media/howto.png?raw=true)
36+
37+
38+
Add Git to the project:
39+
40+
```
41+
cd {new repo folder}
42+
git init
43+
```
44+
2145
## **The Problem**
2246

2347
Starting a Serverless service can be overwhelming. You need to figure out many questions and challenges that have nothing to do with your business domain:

docs/getting_started.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,27 @@ description: AWS Lambda Cookbook Project Getting started
1010
* [poetry](https://pypi.org/project/poetry/){target="_blank"} - Make sure to run ``poetry config --local virtualenvs.in-project true`` so all dependencies are installed in the project '.venv' folder.
1111
* For Windows based machines, use the Makefile_windows version (rename to Makefile). Default Makefile is for Mac/Linux.
1212

13+
## Cookiecutter Option
14+
15+
You can get a cleaner version of this repository without using the template button on GitHub with cookiecutter.
16+
17+
* Cookiecutter - install with pip/brew ``brew install cookiecutter`` or ``pip install cookiecutter`
18+
19+
Then run:
20+
21+
``cookiecutter gh:ran-isenberg/cookiecutter-serverless-python``
22+
23+
Answer the questions to select repo name, service name, etc.:
24+
25+
![logo](https://github.com/ran-isenberg/cookiecutter-serverless-python/blob/main/media/howto.png?raw=true)
26+
27+
Add Git to the project:
28+
29+
``cd {new repo folder} ; git init``
30+
31+
Now you can setup your developer environment and deploy to AWS
32+
<br></br>
33+
1334
## **Creating a Developer Environment**
1435

1536
1. Run ``make dev``

0 commit comments

Comments
 (0)