diff --git a/README.md b/README.md index 52562e3..b8f03c8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,41 @@ -# Spotlight +# West Sound Hall Website -Spotlight is a [Tailwind UI](https://tailwindui.com) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org). +This is the website for the West Sound Hall and Community Club on Orcas Island, WA. -## Getting started +https://westsoundhall.org -To get started with this template, first install the npm dependencies: +## 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 + +The homepage has a list of upcoming events. This list is created from [`src/app/upcoming-events.json`](https://git.grosinger.net/tgrosinger/west-sound-hall/src/branch/main/src/app/upcoming-events.json). To update the events listed, modify that file, tag a new version, and then update the running container to the latest version. + +Events in the past will be automatically hidden from view. + +### 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 @@ -24,19 +55,8 @@ npm run dev Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website. -## Customizing - -You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files. - ## License -This site template is a commercial product and is licensed under the [Tailwind UI license](https://tailwindui.com/license). +This site is based off of the Spotlight template from Tailwind, and licensed under the [Tailwind UI license](https://tailwindui.com/license). -## Learn more - -To learn more about the technologies used in this site template, see the following resources: - -- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation -- [Next.js](https://nextjs.org/docs) - the official Next.js documentation -- [Headless UI](https://headlessui.dev) - the official Headless UI documentation -- [MDX](https://mdxjs.com) - the MDX documentation +It was purchased by Tony Grosinger.