jr/jakesphotos
1
0
Fork 0
mirror of https://github.com/runyanjake/jakesphotos.git synced 2026-03-26 05:23:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Jake Runyan 2026-03-04 21:24:18 -08:00
parent abd982677f
commit 6fd67e6057
1 changed files with 13 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,36 +1,6 @@
# jakesphotos
A simple photography portfolio page written in vanilla React.
## First Time Setup
1. Create basic react app.
```
npx create-react-app portfolio
```
2. Install missing packages
```
npm install web-vitals
npm install react-router-dom
npm install masonry-layout
npm install react-helmet
```
3. Test changes/fixes with
```
npm install
npm start
```
## Running
### Local development
```
npm start
```
### Docker
```
docker compose down && docker system prune -af && docker compose build && docker compose up -d && docker logs -f jakesphotos
```
## Page Templates
Pages are defined in `content/` as `index.md` files with YAML frontmatter. The `template` frontmatter key selects which template renders the page. All templates support a `title` key.
@ -132,3 +102,15 @@ Procedure is to
3. Open the shared link, and for each picture right click > open image in new tab.
4. The generated URL should be of the form `https://images.whitney.rip/share/Tr5UMHSuNxQ7C5YgyE10L3J6FaKltllrUjdLttGDnId_MTBF4riEcROs7NqXmC6HJYQ/photos/e03f66a6-a619-4624-a473-860026b3446a/thumbnail?size=preview&key=G4sdLdVrDhEpIFRcIJ9alvI6Re6_CmJGQ1VirR5Y3zjkA22Cr6vMVcviTYpTjq8PnuA&c=S6DnBWy90pmryXsnoQX9CQ3Y%2BBo%3D`
5. URL can be added to the images.js file.
## Running
### Local development
```
npm start
```
### Docker
```
docker compose down && docker system prune -af && docker compose build && docker compose up -d && docker logs -f jakesphotos
```