Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 natobytes

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
65 changes: 64 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,64 @@
# TeslAppBackend
# Volts

Community-curated content catalog for Tesla vehicles — light shows, lock sounds, boombox tracks, wraps, and horn sounds.

Built with [Jekyll](https://jekyllrb.com/) and served via GitHub Pages.

## Content Categories

- **Light Shows** — custom LED sequences
- **Lock Sounds** — sounds that play when locking/unlocking
- **Boombox** — external speaker audio tracks
- **Wraps** — vehicle wrap designs and templates
- **Horn Sounds** — custom horn replacements

## Local Setup

### Prerequisites

- [Ruby](https://www.ruby-lang.org/) (for Jekyll)
- [Bundler](https://bundler.io/) (`gem install bundler`)
- [Node.js](https://nodejs.org/) (for content validation scripts)

### Install Dependencies

```bash
bundle install
npm install
```

### Run Locally

```bash
bundle exec jekyll serve
```

The site will be available at `http://localhost:4000/Volts/`.

### Validate Content

```bash
npm run validate
```

### Build JSON API

```bash
npm run build
```

## Contributing

1. Fork the repository
2. Create a feature branch (`git checkout -b my-new-content`)
3. Add your content as a Markdown file in the appropriate `content/_<category>/` folder
4. Run `npm run validate` to check your submission
5. Commit your changes and open a Pull Request

Each content file uses Jekyll front matter. See existing files in `content/` for examples of the required fields per category.

Pull request templates are provided for each content type — GitHub will prompt you to fill in the relevant details.

## License

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
Loading