https://github.com/csprance/anansi
A story and world building application made with react/electron/redux
https://github.com/csprance/anansi
Last synced: about 1 year ago
JSON representation
A story and world building application made with react/electron/redux
- Host: GitHub
- URL: https://github.com/csprance/anansi
- Owner: csprance
- Created: 2020-08-11T01:52:27.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T08:28:21.000Z (about 3 years ago)
- Last Synced: 2025-02-06T05:31:26.653Z (over 1 year ago)
- Language: TypeScript
- Size: 1.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Electron + TypeScript + React
Boilerplate for a project using Electron, React, Redux and Typescript as well as dev tools
## Installation
Use a package manager of your choice (npm, yarn, etc.) in order to install all dependencies
```bash
npm install
```
```bash
yarn install
```
## Usage
In order to run this project 2 scripts will need to be executed `dev:react` and `dev:electron`, run each one in a different terminal and always run `dev:react` before `dev:electron`, or `dev` to run them in order automatically
```bash
npm run dev:react
```
```bash
npm run dev:electron
```
or
```bash
npm run dev
```
## Packaging
To generate a project package run `package`
```bash
npm run package
```
To generate an installer run `make-installer`
```bash
npm run make-installer
```
## Contributing
Pull requests are always welcome 😃.
## License
[MIT](https://choosealicense.com/licenses/mit/)