https://github.com/bmlt-enabled/dijon-spreadsheet-maker
https://github.com/bmlt-enabled/dijon-spreadsheet-maker
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bmlt-enabled/dijon-spreadsheet-maker
- Owner: bmlt-enabled
- License: gpl-3.0
- Created: 2022-04-20T03:18:14.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-30T10:36:39.000Z (over 2 years ago)
- Last Synced: 2023-09-30T11:44:25.538Z (over 2 years ago)
- Language: JavaScript
- Size: 5.5 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dijon Spreadsheet Maker
Dijon is a system to help synchronize BMLT meeting data with the meeting database maintained by NAWS. There is a server that periodically grabs a snapshot from each participating BMLT root server and that provides an API for accessing snapshots and changes between snapshots. The goal is to grab one snapshot per day -- there might be missing days if something is down, but there should never be more than one snapshot per BMLT server per day.
The spreadsheet maker is a UI for the server. It provides a web-based query builder for producing spreadsheets showing the meeting changes between selected dates for a given service body. The user selects the server, the desired start and end dates, and the service body. At that point the “generate spreadsheet” button will become active and can be pressed to generate and download a spreadsheet. The available start and end dates are bounded by the dates of the first and last snapshots for the selected BMLT server. The available service bodies for the changes spreadsheet are those that are stored for the end snapshot. Finally, if a snapshot isn't available for the desired start or end date, the closest earlier one will be used, and a warning displayed.
## Dijon Server
The default URL for the dijon server used by the spreadsheet maker is https://dijon-api.bmlt.dev. This can be overridden for any of the `npm run` commands using the `--server` flag.
## Development Mode
The spreadsheet maker is written using [SvelteKit](https://kit.svelte.dev/docs/introduction). Clone this repo, connect to the project directory, and install dependencies with `npm install`. If the server API changes, run `npm upgrade dijon-client`.
The following command will start a spreadsheet maker server that can be accessed on http://localhost:3000.
```bash
npm run dev
```
As noted above, to use a different dijon server use the `--server` flag. For example, this command will use a dijon server running on your local machine instead (useful for development and testing).
```bash
npm run dev --server='http://localhost:8000'
```
Finally, this command will start the spreadsheet maker server and open the app in a new browser tab.
```bash
npm run dev -- --open
```
## Building
To create a production version of your app:
```bash
npm run build
```
You can preview the production build with `npm run preview`.
## Publishing (GitHub)
To deploy to gh-pages branch:
```bash
npm run deploy
```
Access the deployed server at https://dijon.bmlt.dev/