Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mnyrop authored Feb 1, 2024
1 parent 8e9058a commit fb3bcbb
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Bibliopolítica: A Digital History of the Chicano Studies Library
# Bibliopolítica
[![deploy](https://github.com/mnyrop/bibliopolitica/actions/workflows/deploy.yml/badge.svg)](https://github.com/mnyrop/bibliopolitica/actions/workflows/deploy.yml)

Exhibit front-end feat. [11ty](https://www.11ty.dev/) + [daisyui](https://daisyui.com/)
IIIF assets via [aperitiiif](https://middlicomp.github.io/aperitiiif/)
A digital history of the Chicano Studies Library. Exhibit front-end feat. [11ty](https://www.11ty.dev/) + [daisyui](https://daisyui.com/). IIIF assets via [aperitiiif](https://middlicomp.github.io/aperitiiif/).

![image labeled the chicano studies libray serials collection with a graphic line logo](https://marii.info/images/bibliopolitica.jpg)


<img alt="image labeled the chicano studies libray serials collection with a graphic line logo" src="https://marii.info/images/bibliopolitica.jpg" height=350/>

## Local Development

Expand All @@ -13,26 +15,28 @@ IIIF assets via [aperitiiif](https://middlicomp.github.io/aperitiiif/)

### Steps
1. Checkout repository & cd into it.
``` sh
git clone https://github.com/mnyrop/bibliopolitica.git && cd bibliopolitica
```
``` sh
git clone https://github.com/mnyrop/bibliopolitica.git && cd bibliopolitica
```
2. Install and/or load Node version
``` sh
nvm install
```
``` sh
nvm install
```
3. Install node modules
``` sh
npm install
```
``` sh
npm install
```
4. Run development server
``` sh
npm start
```
``` sh
npm start
```
5. View in browser at http://localhost:8080/


## Deployment

Current: commits to `main` branch will trigger GitHub action to build, test, and deploy the site to GitHub pages.

Future: commits to `staging` branch will trigger GitHub action to build, test, and deploy the site to GitHub pages; commits to `main` (via Pull Request from `staging`) will build, test, and deploy the site to prod host using SFTP.
- **Current**
- commits to `main` branch will trigger GitHub action to build, test, and deploy the site to GitHub pages
- **Future**
- commits to `staging` branch will trigger GitHub action to build, test, and deploy the site to GitHub pages
- commits to `main` (via Pull Request from `staging`) will build, test, and deploy the site to prod host using SFTP

0 comments on commit fb3bcbb

Please sign in to comment.