Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Poetry configuration to make it easier to setup and use. #27

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Poetry configuration to make it easier to setup and use. #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b53432
Add Poetry configuration to make it easier to setup and use.
Aug 31, 2021
4cf7d6b
Use the appropriate Python version requirement.
Aug 31, 2021
57b24b5
Update documentation, add poetry command to install dependencies.
pjamargh Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,37 @@ https://www.niche-museums.com/about
Read [niche-museums.com, powered by Datasette](https://simonwillison.net/2019/Nov/25/niche-museums/) for a detailed explanation of how this all works.

The content on this site (primary contained in `museums.yaml`) is licensed [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)

## Setup

This project uses *[Poetry](https://python-poetry.org/)* to make it easier to setup the appropriate dependencies to run.

Installation steps for *Poetry* can be checked on their [website](https://python-poetry.org/docs/#installation) but for most of the cases this command line would work:
```
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
```

Install dependencies:
```
poetry install
```

Build the museum database:
```
# On bash
poetry run `pwd`/build.sh
# On fish shell
poetry run (pwd)/build.sh
```

## Run

Start the server:
```
# On bash
poetry run `pwd`/serve.sh
# On fish shell
poetry run (pwd)/serve.sh
```

The address will be printed on the terminal window. The 'Niche Museums' website will be accesible through it.
Loading