56 lines
2.3 KiB
Markdown
56 lines
2.3 KiB
Markdown
# West Sound Hall Website
|
|
|
|
This is the website for the West Sound Hall and Community Club on Orcas Island, WA.
|
|
|
|
https://westsoundhall.org
|
|
|
|
## Running
|
|
|
|
Pre-build containers are created whenever a version is tagged in this repository. Pull the [latest version](https://git.grosinger.net/tgrosinger/-/packages/container/west-sound-hall/) and run on a server with Docker available.
|
|
|
|
```sh
|
|
docker run -p 3000:3000 git.grosinger.net/tgrosinger/west-sound-hall:0.0.14
|
|
```
|
|
|
|
## Updating
|
|
|
|
### Events on the Homepage and the Calendar
|
|
|
|
The events on the calendar are loaded from the westsoundcommunityclub@gmail.com Google Calendar.
|
|
|
|
Please note that all events on the calendar will be displayed. If an event should not reveal the title to the public, add the word "Private" to the event description (not the title).
|
|
|
|
### News Posts
|
|
|
|
News posts are written in [`src/app/news`](https://git.grosinger.net/tgrosinger/west-sound-hall/src/branch/main/src/app/news). Each post requires a directory within this folder, and the directory title will become the last segment of the news post URL.
|
|
|
|
To create a new post, create a new directory in that folder, then within that folder create a `page.mdx`. Use an existing news post as a template by copying its `page.mdx` then modify the author, date, title, description, and the body of the post as needed.
|
|
|
|
Posts are written in [mdx](https://mdxjs.com/) however for most news posts you can just consider the body of the post to be [standard markdown](https://www.markdownguide.org/basic-syntax/).
|
|
|
|
Photos can be added in the same directory as the `page.mdx` file. Refer to another news post for an example of how to embed them.
|
|
|
|
## Developing
|
|
|
|
To get started, first install the npm dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
Next, copy the `.env.example` file from this directory and call it `.env.local`. Fill in the values that have been redacted with their actual secrets. Be sure to use the test environment key from Stripe unless you are setting up production.
|
|
|
|
Next, run the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website.
|
|
|
|
## License
|
|
|
|
This site is based off of the Spotlight template from Tailwind, and licensed under the [Tailwind UI license](https://tailwindui.com/license).
|
|
|
|
It was purchased by [Tony Grosinger](mailto:tony@grosinger.net).
|