Skip to content

update deps, tweaked config, added yarn pkg, and setup distribution w/ docs - 091817 #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
PORT=3000
BROWSER=none
26 changes: 19 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
# See http://help.github.com/ignore-files/ for more about ignoring files.
# See https://help.github.com/ignore-files/ for more about ignoring files.

# dependencies
node_modules
/node_modules

# testing
coverage
/coverage

# production
build
/build

#distribution
/dist
/release

# misc
.DS_Store
.env
npm-debug.log
.env.local
.env.development.local
.env.test.local
.env.production.local

#editor
*.sublime-project
*.sublime-workspace

.idea
npm-debug.log*
yarn-debug.log*
yarn-error.log*
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

4 changes: 2 additions & 2 deletions Procfile
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
react: npm start
electron: node src/electron-wait-react
react: npm run react-start
electron: npm run electron-start
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
#bootstrap create-react-app and electron
## Overview

Code repo for post on freeCodeCamp.
Welcome to the future of application development! This project is aimed to provide developers with skeleton code to create robust cross-platform desktop applications using [Electron](https://electron.atom.io/), [NodeJS](https://nodejs.org/en/), [React](https://facebook.github.io/react/), and [Semantic UI](https://semantic-ui.com/).

https://medium.freecodecamp.com/building-an-electron-application-with-create-react-app-97945861647c#.ze6c9qin1
Check out the [Getting Started](https://github.com/1-14x0r/electron-react-semantic-ui-app/wiki/Getting-Started) guide if you would like to learn how this project was created from the ground up. Basic knowledge of how to [install](https://nodejs.org/en/download/) and use [NodeJS](https://nodejs.org/en/docs/guides/getting-started-guide/) is required. It is also a good idea to familiar yourself with the [Electron](https://electron.atom.io/docs/tutorial/quick-start/) toolkit.

There is another branch, [npm-start](https://github.com/csepulv/electron-with-create-react-app/tree/npm-start)
It uses `npm-start` instead of `npm run dev`. (change submitted by [vcarl](https://github.com/vcarl)) Details are in this [pull request](https://github.com/csepulv/electron-with-create-react-app/pull/2)
### Pre-Requistes
- Text Editor such as [Sublime](https://www.sublimetext.com/) or [Notepad++](https://notepad-plus-plus.org/)
- [NodeJS](https://nodejs.org/en/) - [download](https://nodejs.org/en/download/current/)
- [Yarn](https://yarnpkg.com/en/) - [download](https://yarnpkg.com/en/docs/install)

Thanks to [marbemac](https://github.com/marbemac) for submitting a pull request that captures logging output. It can be found in [logging-capture](https://github.com/csepulv/electron-with-create-react-app/tree/logging-capture)
## Quick Start
- clone project into a directory
- navigate into project directory
- run 'node install' in the console
- wait..
- run 'npm start' or 'yarn start'
- electron applicaiton should display after a short time

Thanks to [vicentedealencar](https://github.com/vicentedealencar) for an example of using [electron-builder](https://github.com/electron-userland/electron-builder) for packaging. Details are [here](https://github.com/vicentedealencar/electron-with-create-react-app/commit/f1729381d588e65ac140ce5a08cc6277babd9641).
You can change the port number that the development server runs on for hot code deployment (auto refresh code changes) in the .env file located in the root of the project.

Edit app.js located in your ./src directory to start coding! GLHF<3

#### References
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). You can find the most recent user guide to this project [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md)

#### Special Thanks
project setup - [Christian Sepulveda](https://github.com/csepulv)
logging output - [marbemac](https://github.com/marbemac)
packaging - [vicentedealencar](https://github.com/vicentedealencar)
Binary file added assets/torchie.icns
Binary file not shown.
Binary file added assets/torchie.ico
Binary file not shown.
Binary file added assets/torchie.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading