Skip to content

Commit 46b5931

Browse files
committed
Add README and update Makefile
1 parent 4aad0e6 commit 46b5931

File tree

2 files changed

+48
-6
lines changed

2 files changed

+48
-6
lines changed

Makefile

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
.DEFAULT_GOAL := help
2-
.PHONY: help install html css build serve netlify
2+
.PHONY: help html css build serve netlify
33

44
help: ## this help dialog
55
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
66

7-
install: ## install all dependencies, including Poetry
8-
python3 -m pip install poetry && poetry env use 3 && poetry install
9-
107
html: ## build HTML with corvid
118
poetry run corvid
129

@@ -17,7 +14,7 @@ build: ## build site in output/
1714
make html && make css
1815

1916
serve: ## serve site from output/
20-
poetry run python -m http.server 8000 -d output
17+
poetry run python -m http.server 8765 -d output
2118

2219
netlify: ## publish on Netlify
23-
make install && make build
20+
python3 -m pip install poetry && poetry env use 3 && poetry install && make build

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# SoCalPython.org
2+
3+
4+
This is the source repo for [SoCalPython.org], the official SoCal Python website. 🐍
5+
6+
It's built using [corvid] and below instructions rely on [Poetry].
7+
8+
9+
## Setup
10+
11+
1. Install [Poetry]
12+
2. Run `poetry install`
13+
14+
15+
## Developing
16+
17+
1. Run `make serve` in a terminal window continuously
18+
2. Go to [http://localhost:8765]
19+
3. Make changes
20+
4. Run `make build` in another terminal window
21+
5. Refresh to see changes
22+
6. Repeat steps 3, 4, and 5 as needed
23+
24+
25+
## Infrastructure
26+
27+
The site is deployed on [Netlify] from the `main` branch of this repository.
28+
The domain is registered by [@nkantar] through [Hover], and SSL is provided by [Let's Encrypt].
29+
30+
31+
## Code of Conduct
32+
33+
The SoCal Python community has a [Code of Conduct], which covers contributing to this codebase as well as participating in the community in any way.
34+
Doing so implies you agree to abide by its terms.
35+
36+
37+
[SoCalPython.org]: https://socalpython.org/ "SoCalPython.org | The official site of the Los Angeles Python programming language community."
38+
[corvid]: https://github.com/di/corvid/ "GitHub - di/corvid: An opinionated simple static site generator"
39+
[Poetry]: https://python-poetry.org/ "Poetry - Python dependency management and packaging made easy"
40+
[http://localhost:8765]: http://localhost:8765
41+
[Netlify]: https://netlify.com "Netlify: Develop & deploy the best web experiences in record time"
42+
[@nkantar]: https://github.com/nkantar "nkantar (Nik Kantar) · GitHub"
43+
[Hover]: https://hover.com "Domain Names | Buy Domains & Email At Hover.com"
44+
[Let's Encrypt]: https://letsencrypt.org/ " Let's Encrypt"
45+
[Code of Conduct]: https://socalpython.org/conduct/ "SoCalPython.org | Code of Conduct"

0 commit comments

Comments
 (0)