Skip to content

Commit

Permalink
correct run commands
Browse files Browse the repository at this point in the history
  • Loading branch information
bmos committed Feb 20, 2024
1 parent f8e73df commit 69f70cf
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
15 changes: 13 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,30 @@ install the required packages by running the following commands from inside the
```shell
python3 -m venv venv
```

```shell
source venv/bin/activate
```

```shell
python3 -m pip install -e .[dev]
```

```shell
pre-commit install
```

```
```shell
python3 -m src.app
```

## Code Submissions

If your text editor doesn't support [.editorconfig](https://github.com/MaineDSA/membership_dashboard/blob/main/.editorconfig), please reference it for some basic formatting norms.
If your text editor doesn't
support [.editorconfig](https://github.com/MaineDSA/membership_dashboard/blob/main/.editorconfig), please reference it
for some basic formatting norms.
Regardless, `ruff format .` should be run to standardize formatting before attempting to commit.

Some parts of this module (mostly those involving list scanning) feature unit tests, so please run `pytest` in the project directory before committing.
Some parts of this module (mostly those involving list scanning) feature unit tests, so please run `pytest` in the
project directory before committing.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ install the required packages by running the following commands from inside the
```shell
python3 -m venv venv
```

```shell
source venv/bin/activate
```

```shell
python3 -m pip install .
```
Expand All @@ -33,7 +35,7 @@ python3 -m pip install .
7. Open a terminal and run the following command to start the dashboard:

```shell
python3 src/app.py
python3 -m src.app
```

8. Open your browser and go to `http://localhost:8050` to view the dashboard.
Expand Down

0 comments on commit 69f70cf

Please sign in to comment.