-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,38 @@ | ||
# Bibliopolitica | ||
# Bibliopolítica: A Digital History of the Chicano Studies Library | ||
|
||
## Getting Started | ||
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) | ||
|
||
## Local Development | ||
|
||
### Prerequisites | ||
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | ||
- [NVM](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) | ||
|
||
### Steps | ||
1. Checkout repository & cd into it. | ||
``` sh | ||
git clone https://github.com/mnyrop/bibliopolitica.git && cd bibliopolitica | ||
``` | ||
2. Install and/or load Node version | ||
``` sh | ||
nvm install | ||
``` | ||
3. Install node modules | ||
``` sh | ||
npm install | ||
``` | ||
4. Run development server | ||
``` 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. |