This repository contains the source code for the official Open Neuromorphic (ONM) website, live at open-neuromorphic.org. Our goal is to foster a collaborative community around neuromorphic computing by providing educational content, resources, and a platform for sharing knowledge and projects.
- Static Site Generation: Built with the Hugo (Extended) for speed and security.
- Modern Styling: Styled with Tailwind CSS for a utility-first workflow.
- Community Focused: Features contributor profiles, workshops, student talks, and community-led initiatives.
- Resource Hubs: Curated guides for Neuromorphic Hardware and Software.
- Automated Deployments: CI/CD pipeline using GitHub Actions for automated builds and deployments.
- Dynamic OG Images: Automatically generated Open Graph images for better social sharing.
- Image Attribution: Simple front matter configuration to give credit for banner images.
To run the website locally for development, ensure you have the required prerequisites and follow these steps.
- Hugo (Extended version): v0.147.7 or later
- Node.js: v22.16.0 or later (which includes npm)
- Go: v1.24.3 or later
-
Clone the repository:
git clone https://github.com/open-neuromorphic/open-neuromorphic.github.io.git cd open-neuromorphic.github.io -
Install dependencies: This project uses Node.js to manage development tools and dependencies.
npm install
-
Run the development server: This command starts Hugo's local server with live-reloading. The site will be available at
http://localhost:1313/.npm run dev
This project uses npm to manage common tasks:
npm run dev: Starts the Hugo development server for local development.npm run build: Creates a production-ready build of the site in the/publicdirectory.npm run build-preview: Builds a minified version of the site and serves it locally for previewing.npm run og-images: Runs the script to generate Open Graph images for social sharing.
We welcome contributions of all kinds! Whether you're adding content, fixing a bug, or improving the code, your help is greatly appreciated.
To get started, please read our detailed CONTRIBUTING.md guide.
It covers everything you need to know, including:
- How to report issues and suggest features.
- The pull request workflow.
- Specific guidelines for adding blog posts, events, and other content.
- Coding standards and commit message conventions.
For community discussions and questions, join us on our Discord server.
The website's theme and code are licensed under the MIT License. See the LICENSE file for more details. Content contributed to the site is shared under the same license unless otherwise specified.