A simple and efficient cross-platform note-taking application built with Electron, React, Redux, and TypeScript. This project also uses Jest for unit testing, ensuring code quality and reliability.
- Cross-Platform: Works seamlessly on Windows, macOS, and Linux.
- React & Redux: A dynamic front-end built with React and state management handled by Redux.
- TypeScript: Strongly typed codebase for improved reliability and maintainability.
- Electron: Desktop application experience using web technologies, with dark and light themes for readability.
- Jest: Comprehensive unit tests to ensure stability and code correctness.
- Easy Note Management: Create, edit, and delete notes with a clean and intuitive interface.
To set up and run the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/semsion/note-taking-app-electron-react-redux-ts.git
-
Navigate to the project directory:
cd note-taking-app-electron-react-redux-ts -
Install dependencies:
npm install
-
Start the application:
npm run start
To run the test suite using Jest:
npm run test
If you receive any errors such as The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing I'm aborting now, you may need to run the following:
sudo chown root <path-to-cloned-repository>/note-taking-app-electron-react-redux-ts/node_modules/electron/dist/chrome-sandbox
sudo chmod 4755 <path-to-cloned-repository>/note-taking-app-electron-react-redux-ts/node_modules/electron/dist/chrome-sandbox