Skip to content

Commit 3e0fa23

Browse files
ran-isenbergRan Isenberg
and
Ran Isenberg
authored
docs: improve readme (#638)
Co-authored-by: Ran Isenberg <ran.isenberg@ranthebuilder.cloud>
1 parent b5105f5 commit 3e0fa23

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
dev:
66
pip install --upgrade pip pre-commit poetry
7-
make deps
87
pre-commit install
9-
poetry shell
8+
poetry config --local virtualenvs.in-project true
9+
poetry install
1010

1111
lint:
1212
@echo "Running flake8"

Makefile_windows

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
dev:
44
pip install --upgrade pip pre-commit poetry
5-
make deps
65
pre-commit install
7-
poetry shell
6+
poetry config --local virtualenvs.in-project true
7+
poetry install
88

99
lint:
1010
@echo "Running flake8"

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,16 @@ Answer the questions to select repo name, service name, etc.:
3535
![logo](https://github.com/ran-isenberg/cookiecutter-serverless-python/blob/main/media/howto.png?raw=true)
3636

3737

38-
Add Git to the project:
38+
**That's it, your developer environment has been set! you are ready to deploy the service:**
3939

4040
```
4141
cd {new repo folder}
42-
git init
42+
poetry shell
43+
make deploy
4344
```
4445

46+
You can also run 'make pr' will run all checks, synth, file formatters , unit tests, deploy to AWS and run integration and E2E tests.
47+
4548
## **The Problem**
4649

4750
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: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ Answer the questions to select repo name, service name, etc.:
2424

2525
![logo](https://github.com/ran-isenberg/cookiecutter-serverless-python/blob/main/media/howto.png?raw=true)
2626

27-
Add Git to the project:
27+
That's it! you are ready to go and deploy the service to AWS.
2828

29-
``cd {new repo folder} ; git init``
29+
``cd {new repo folder}``
30+
``poetry shell``
31+
``make deploy``
3032

31-
Now you can setup your developer environment and deploy to AWS
3233
<br></br>
3334

34-
## **Creating a Developer Environment**
35+
## **Creating a Developer Environment without cookiecutter**
3536

3637
1. Run ``make dev``
37-
2. Run ``poetry install``
3838

3939
## **Deploy CDK**
4040

0 commit comments

Comments
 (0)