Skip to content

Ho1yShif/shack-notes

Repository files navigation

shack-notes

Shack-themed notes app built with Electron and React.

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • Node.js (version 16 or higher recommended)
  • npm (comes with Node.js)

Installation

  1. Clone the repository:
git clone https://github.com/Ho1yShif/shack-notes.git
cd shack-notes
  1. Install dependencies:
npm install
  1. Install React dependencies (if not already installed):
npm install react react-dom web-vitals

Note: React and React-DOM are required for the app to function. If you encounter a blank screen when running the app, make sure these dependencies are installed.

Run the Application

Development Mode

To run the application in development mode with hot-reload:

npm run dev

This will start the Electron application with the development server running. Any changes you make to the code will automatically reload the app.

Build

To build the application for production:

npm run build

This compiles the TypeScript code and bundles the application into the dist/ directory.

About

Shack notes app built with Electron and React

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published