Tesla Coil ⚡

Tesla Coil is v2 the static site generation tool for Neutron based on Lightning Rod.

Installation • Deploy • Develop • Credits • Support • Related • License

Installation

Follow the below instructions **in the provided order** to complete the installation of Tesla Coil.

Download

To download Tesla Coil, run the following script.

# Download the latest version of Tesla Coil
git clone https://github.com/Neutron-Creative/Tesla-Coil.git
# CD into newly downloaded project
cd Tesla-Coil
# Install the neccessary local dependencies
npm install

System Dependencies

The following packages are required in order to run Tesla Coil.

• NodeJS v6+
• Supabase v1+
• Go v1.1.3+
• Goscrape

Environment variables

The following variables are required in order for Tesla Coil to run.

• SUPABASE_URL
• SUPABASE_KEY
• NETLIFY_TOKEN
• GITHUB_TOKEN
• GITHUB_USER
• GITHUB_ORGANIZATION

You can set them with the following script.

# URL of your Supabase client
export SUPABASE_URL='<your-supabase-url>';
# Private master key for your Supabase client
export SUPABASE_KEY='<your-supabase-key>';
# Private Netlify Client Token
export NETLIFY_TOKEN='<your-netlify-token>';
# Private Github Token
export GITHUB_TOKEN='<your-github-token>';
# Github user to commit from
export GITHUB_USER='<your-github-username>';
# Github organization to host repos
export GITHUB_ORGANIZATION='<your-github-organization>';

Once you have go installed, you will also need to install goscrape with the following script.

go get github.com/cornelk/goscrape

Deploy

Now that you're installed, simply run the following command from the project root directory to publish your first Tesla Coil instance.

# Run in shell
npm run start
# Optionally, run in tmux
tmux new-session -d -s tesla_coil
tmux send-keys 'npm run start' C-m
tmux detach -s tesla_coil

Develop

To develop for Tesla Coil (hot-reloading enabled), simply run the following command from the project root directory after completing install.

# Install dev dependencies
npm --production=false install
# Run dev environment
npm run dev

Credits

Tesla Coil was built by the following individuals.

• Jim Bisenius (@jim_bisenius)

Currently, Tesla Coil lacks contributors outside its founders at Neutron Creative, but, you can help. Visit the issues page today and create your first pull request to get featured here!

Support

Need help? Our community support is online 9AM-5PM EST M-F, and our enterprise support team is available 24/7/365 via (email or phone). Don't hesitate to get in touch, we love to help and we're often able to resolve issues within the hour!

Related

Tesla Coil is Neutron Creative product, created and hosted free of charge in the mission of open-source. To learn more about our mission, visit neutroncreative.com

Be sure to check out our other products as well!

• Capture, Simplified screenshot API (https://capture.neutron.so)
• Sponsorware, Sell software with Github Sponsors (https://sponsorware.neutron.so)
• Cowlytics, Real-time Stripe analytics & forcesting for SaaS (https://www.cowlytics.co)
• Neutron, Faster websites in one-click (https://neutroncreative.com)

License

Copyright (C) 2020 Neutron Creative Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>