Skip to content

Commit f664568

Browse files
authored
Minor changes to Readme and make file to simplify steps for running app in dev (#2157)
1 parent 384e2f6 commit f664568

File tree

2 files changed

+5
-76
lines changed

2 files changed

+5
-76
lines changed

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,19 @@ smoke-test:
4848

4949
.PHONY: run
5050
run: ## Run the web app
51-
flask run -p 6011 --host=0.0.0.0
51+
poetry run flask run -p 6011 --host=0.0.0.0
5252

5353
.PHONY: run-celery-local
5454
run-celery-local: ## Run the celery workers with all the queues
55-
./scripts/run_celery_local.sh
55+
poetry run ./scripts/run_celery_local.sh
5656

5757
.PHONY: run-celery-local-filtered
5858
run-celery-local-filtered: ## Run the celery workers with all queues but filter out common scheduled tasks
59-
./scripts/run_celery_local.sh 2>&1 >/dev/null | grep -iEv 'beat|in-flight-to-inbox|run-scheduled-jobs|check-job-status'
59+
poetry run ./scripts/run_celery_local.sh 2>&1 >/dev/null | grep -iEv 'beat|in-flight-to-inbox|run-scheduled-jobs|check-job-status'
6060

6161
.PHONY: run-celery-purge
6262
run-celery-purge: ## Purge the celery queues
63-
./scripts/run_celery_purge.sh
63+
poetry run ./scripts/run_celery_purge.sh
6464

6565
.PHONY: run-db
6666
run-db: ## psql to access dev database

README.md

Lines changed: 1 addition & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -17,78 +17,7 @@ Contains:
1717
For any issues during the following instructions, make sure to review the
1818
**Frequent problems** section toward the end of the document.
1919

20-
### Local installation instruction
21-
22-
#### On OS X:
23-
24-
1. Install PyEnv with Homebrew. This will preserve your sanity.
25-
26-
`brew install pyenv`
27-
28-
2. Install Python 3.10.8 or whatever is the latest
29-
30-
`pyenv install 3.10.8`
31-
32-
3. If you expect no conflicts, set `3.10.8` as you default
33-
34-
`pyenv global 3.10.8`
35-
36-
4. Ensure it installed by running
37-
38-
`python --version`
39-
40-
if it did not, take a look here: https://github.com/pyenv/pyenv/issues/660
41-
42-
5. Install `poetry`:
43-
44-
`pip install poetry==1.3.2`
45-
46-
6. Restart your terminal and make your virtual environtment:
47-
48-
`poetry env use $(which python)`
49-
50-
8. Verify that the environment was created and activated by poetry
51-
52-
`poetry env list`
53-
54-
9. Install [Postgres.app](http://postgresapp.com/).
55-
56-
10. Create the database for the application
57-
58-
`createdb --user=postgres notification_api`
59-
60-
11. Install the required environment variables via our LastPast Vault
61-
62-
Within the team's *LastPass Vault*, you should find corresponding folders for this
63-
project containing the `.env` content that you should copy in your project root folder. This
64-
will grant the application necessary access to our internal infrastructure.
65-
66-
If you don't have access to our *LastPass Vault* (as you evaluate our notification
67-
platform for example), you will find a sane set of defaults exists in the `.env.example`
68-
file. Copy that file to `.env` and customize it to your needs.
69-
70-
12. Install all dependencies
71-
72-
`poetry install`
73-
74-
1. Generate the version file ?!?
75-
76-
`make generate-version-file`
77-
78-
14. Run all DB migrations
79-
80-
`flask db upgrade`
81-
82-
15. Run the service
83-
84-
`make run`
85-
86-
15a. To test
87-
88-
`poetry install --with test`
89-
90-
`make test`
91-
20+
### Local installation instruction (Use Dev Containers)
9221
#### In a [VS Code devcontainer](https://code.visualstudio.com/docs/remote/containers-tutorial)
9322

9423
1. Install VS Code

0 commit comments

Comments
 (0)