diff --git a/README.md b/README.md index c0eb017..6205c12 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,52 @@ ![Creative Code Berlin Logo](https://creativecode.berlin/logo.svg) -# Creative Code Berlin Website +# Creative Code Berlin website -Welcome to the Creative Code Berlin website source code, you can visit our website [creativecode.berlin](http://creativecode.berlin) +Welcome to the Creative Code Berlin website source code. You can view the site at [creativecode.berlin](http://creativecode.berlin) +## Build and run locally -## Adding Artworks +After cloning the repo, follow these steps: -Add the generated JSON generated to the [project.js file](/assets/projects.js). -We must host ShaderToy sketches ourselves since 2026. [Here's how to do it](docs/shadertoy.md). +```shell +# Install dependencies +npm install +# Start development server +npm run dev +``` -## Development Instructions +This renders the site locally. You can browse it at `http://localhost:3000`. The server has hot reloading, so your changes are reflected immediately in the browser. -Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more about nuxt.js. -## Setup +## Netlify auto-deploy -Make sure to install the dependencies: +If you want to publish any changes, create a new branch and work on that. Push the branch to GitHub and create a Pull Request (PR). -```bash -# npm -npm install -``` +The Netlify integration will run "checks" in the PR, which include creating a pre-release preview. You can view this at `https://deploy-preview-NNN--vigilant-edison-dfd992.netlify.app`, where NNN is the PR number. Unfortunately this only happens once; if you push additional commits to the PR, the preview is not updated. -## Development Server +Merging the PR to master deploys the changes on the live website. -Start the development server on `http://localhost:3000`: +The Netlify actions are triggered automagically through the Netlify App, which is configured under the repository's [Settings / GitHub Apps](https://github.com/CreativeCodeBerlin/creativecode.berlin/settings/installations). -```bash -# npm -npm run dev -``` +## Adding artworks -## Production +Add the generated JSON generated to the [project.js file](/assets/projects.js). +We must host ShaderToy sketches ourselves since 2026. [Here's how to do it](docs/shadertoy.md). -Build the application for production: -```bash -# npm -npm run build -``` +## More info on Nuxt + +The site uses Vue with server-side rendering via Nuxt. More info on Nuxt: [Introduction](https://nuxt.com/docs/4.x/getting-started/introduction) and [Deployment](https://nuxt.com/docs/4.x/getting-started/deployment). -Locally preview production build: +The short of it is that the site is authored like a dynamic single-page app built in Vue, except pages are pre-rendered by Nuxt on the server side for speed and static joy. The client-side dynamic fun begins in the `onMounted` hook in the Vue files. -```bash -# npm +You can build and view the site's production version locally like so: + +```shell +npm run build npm run preview ``` -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. diff --git a/public/_redirects b/public/_redirects deleted file mode 100644 index f63340c..0000000 --- a/public/_redirects +++ /dev/null @@ -1,13 +0,0 @@ -# Generated by Nuxt -/meetup https://www.meetup.com/creativecodeberlin/ 301 -/ccs https://funprogramming.org/pad/p/ccs 301 -/archive https://creativecodeberlin.github.io/Stammtisch/ 301 -/jam https://funprogramming.org/pad/p/ccjam 301 -/mastodon https://genart.social/@creativeCodeBLN 301 -/chat https://funprogramming.org/chat 301 -/discord https://discord.gg/CwNUGu5 301 -/telegram https://t.me/creativecodeberlin 301 -/instagram https://www.instagram.com/creativecodebln/ 301 -/github https://github.com/CreativeCodeBerlin 301 -/learn https://sableraph.notion.site/Creative-Code-resources-for-beginners-and-beyond-p5-js-edition-38fce7d30b1d41a9a626ab70440f40ca 301 -/codeofconduct https://berlincodeofconduct.org 301 \ No newline at end of file