jayruizjr/sveltestorm

SvelteStorm is an open-source IDE with a built-in State Manager window for viewing your svelte project in real-time

SvelteStorm

Table of Contents

• Introduction
• How to Use
• For Mac (M1 Chip)
• For Linux (DEB)
• For other devices
• Key Features
• Authors
• Contributing
• License

SvelteStorm

A Svelte IDE like no other. Embrace the storm.

SvelteStorm is a new and improved open-source integrated developer environment (IDE). SvelteStorm is specifically tailored to provide all of the essential tools a Svelte developer needs to build a Svelte application. The IDE contains a code editor, a terminal environment, a file directory, a browser view, developer tools, and a component state viewer. SvelteStorm was built using Svelte and Electron and is downloadable for Windows, Linux, and Mac operating systems. With the new and improved SvelteStorm, it contains a simple, dark-mode UI design, all the dev dependencies up-to-date, and the code editor has been switched from Monaco to CodeMirror. From its modernized and clean UI, to its quick loading time and component state window, SvelteStorm is a rising star for the Svelte community.

How To Use SvelteStorm

1. Click on the 'File' menu button in the top-left corner, then open a file or folder to begin editing. (You can also use CTRL+O to open a folder with a shortcut)
2. When a Svelte project is opened, you will notice the State Manager populates in the bottom-left corner of the window, which displays all of your Svelte components and what props they export.
3. To use the browser window, boot up your server in the terminal if need be, then input the server port (i.e. 8080) into the form on the the window, then press enter.
4. Developer Tools are accessible via the 'Help' button in the top menu, or by using CTRL+D
5. For more information, click on SvelteStorm's Website via the 'Help' button

for VSCode users the link below can provide insight to potential installation issues:

open-source-labs#57

Mac Installation

The Mac distributable is in progress, but Mac users can still follow the "Other Devices Installation" instructions below to use SvelteStorm!

Linux Installation

1. Download SvelteStorm
2. Unzip the file and use an installer (Such as Eddy) to install the application
3. SvelteStorm is now ready! Embrace the storm!

Other Devices Installation

1. Clone this repo to your code editor of choice
2. Run npm install to install dependencies
3. Run npm start and SvelteStorm will open up and be ready for use!

Key Features

1. A code editor utilizing the “Dracula” dark-mode theme with syntax highlighting and bracket pair identification
2. A fully functional terminal environment to navigate file systems and run code
3. A browser window for developers to see what their projects look like on the client end
4. A state management viewer to track where props are being declared within the project
5. A functioning file directory where users can open files and navigate folders to edit within the code editor

Authors

Arron Nestor | Aye Moe | Frank Stepanski | Kevin Sarchi | Sam Filip | Cayla Co | Swetha Kunda | Miller Johnston | Sina Kahrobaei

Contributing

There are many ways in which you can participate in this project, for example:

• Check for known issues that you may be able to provide input on
• Submit bugs and feature requests, and help us verify as they are checked in
• Review source code changes
• Review the documentation and make pull requests for anything from typos to additional and new content

License

This project is licensed under the MIT License - see the LICENSE file for details