66 lines
1.4 KiB
Markdown
66 lines
1.4 KiB
Markdown
# SPORE Website
|
|
|
|
Technical documentation and showcase for the SPORE ecosystem - a distributed embedded system framework for ESP8266 microcontrollers.
|
|
|
|
## Features
|
|
|
|
- Clean, technical presentation of the SPORE ecosystem
|
|
- Showcases SPORE Core, SPORE UI, and SPORE LEDLab
|
|
- Screenshots and visual demonstrations
|
|
- Code examples and technical specifications
|
|
- Built with vanilla JavaScript and CSS
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js (v14 or higher)
|
|
- npm (v6 or higher)
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Run
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
The website will be available at `http://localhost:3002`
|
|
|
|
### Docker
|
|
|
|
Build and run with Docker:
|
|
|
|
```bash
|
|
# Build image
|
|
docker build -t spore-website .
|
|
|
|
# Run (maps container port 3002 to host 3002)
|
|
docker run --rm -p 3002:3002 spore-website
|
|
|
|
# Override port (optional)
|
|
docker run --rm -e PORT=8080 -p 8080:8080 spore-website
|
|
```
|
|
|
|
## Technology Stack
|
|
|
|
- **Backend:** Express.js
|
|
- **Frontend:** Vanilla JavaScript, CSS3, HTML5
|
|
- **Design:** Clean, dark theme with technical focus
|
|
|
|
## Structure
|
|
|
|
```
|
|
spore-website/
|
|
├── server.js # Express.js server
|
|
├── public/ # Static files
|
|
│ ├── index.html # Main HTML page
|
|
│ ├── styles.css # Stylesheet
|
|
│ ├── script.js # Minimal JavaScript
|
|
│ └── assets/ # Screenshots and images
|
|
└── package.json # Dependencies
|
|
``` |