Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decosoftware/deco-ide
The React Native IDE
https://github.com/decosoftware/deco-ide
Last synced: about 1 month ago
JSON representation
The React Native IDE
- Host: GitHub
- URL: https://github.com/decosoftware/deco-ide
- Owner: decosoftware
- License: agpl-3.0
- Created: 2016-05-19T21:29:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-25T13:20:44.000Z (almost 5 years ago)
- Last Synced: 2024-09-27T03:03:36.956Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://www.decosoftware.com/
- Size: 389 MB
- Stars: 5,840
- Watchers: 144
- Forks: 311
- Open Issues: 102
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-electron-zh - Deco - React Native IDE. (Apps / Open Source)
README
[](https://travis-ci.org/decosoftware/deco-ide) [](https://www.bountysource.com/teams/decosoftware/issues?tracker_ids=38081366) [](http://decoslackin.herokuapp.com/)
### The all-in-one solution for building React Native applications.
You can get started right away on your React Native project by installing Deco and creating a new project — it's fast and there's no manual setup needed. File scaffolding handles your boilerplate. Ready-made components drop right into your code. Properties are graphically editable through the property inspector. It's an entirely new way to write, tweak, and re-use code.
#### [Download Deco for Mac](https://www.decosoftware.com/download)
#### [Documentation](https://www.decosoftware.com/docs) to get you started on Deco IDE.
#### [Open an Issue](#opening-issues) for bug reports and feature requests.
#### [Join Slack](https://decoslackin.herokuapp.com) to talk with us.
## Table of Contents
- [Setup for Development](#setup-for-development)
- [Environment](#environment)
- [Install](#clone-and-install-dependencies)
- [Development](#development)
- [Production Build](#testing-a-production-build)
- [Contributing](#contributing)
- [Opening Issues](#opening-issues)
- [Becoming a Contributor](#becoming-a-contributor)
- [Feedback](#feedback)
## Setup for Development
### Environment
#### OSX
It is recommended that you use node v5.x and npm 3.x for best results. This project also requires the Ruby 'Bundler' gem.
Installing these on your Mac is easy with [Homebrew](brew.sh)
```
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Now that [Homebrew](brew.sh) is installed you can run these commands:
```
brew install node
brew install ruby
gem install bundler
```
#### Linux
Linux is not supported at this time.
#### Windows
Windows is not supported at this time.
### Clone and Install Dependencies
```
$ git clone [email protected]:decosoftware/deco-ide
$ cd ./deco-ide/web
$ npm install
$ bundle install
$ cd ../desktop
$ npm install
$ npm run copy-libs
$ cd ../shared
$ npm install
$ cd ../desktop/libs/Scripts/sync-service
$ npm install
```
### Development
Deco core is split into three sub-projects...
1. [Web](web/README.md)
- A webpack bundle that assumes it's been loaded by Electron's BrowserWindow.
2. [Desktop](desktop/README.md)
- A webpack bundle that runs in Electron's NodeJS environment and controls the desktop APIs.
3. [Shared](shared/README.md)
- Shared constants for communicating over our IPC (inter-process communication) abstraction layer.
#### Quick Start
```
$ cd ./deco-ide
$ ./run-dev.js
```
#### Manual Start
Occasionally it is helpful to stop and restart the `desktop` gulp task without stopping the `web` gulp task. To do this you can run the following commands...
```
$ cd ./web
$ npm run watch
```
This command will:
1. Watch the `./web/src` directory and re-build on any changes to the code
2. Serve the build on localhost:8080
```
# Open a new terminal window
$ cd ./desktop
$ npm run start
```
This command will:
1. Build `./desktop/src` and place the result into `./desktop/build/app.js`
2. Launch a local Electron binary and load in the bundle from `desktop/build/app.js`
### Testing a Production Build
```
$ cd ./desktop
$ npm run pack
```
The resulting .pkg file will be output to `./dist/osx/Deco-$VERSION.pkg`
This build is for local testing only. When you install, the system will generate a warning about this being from an unapproved developer — this is because the package is not signed when building locally.
## Contributing
### Opening Issues
##### Issues are intended for bug reporting and feature requests.
Before you open a new issue, make sure it isn't already in the list of [existing issues.](http://www.github.com/decosoftware/deco-ide/issues) If you believe you've found a new bug, it helps to include any relevant logs in your description.
You can find the logs file at `~/Library/Application Support/com.decosoftware.Deco/logs.out`
### Becoming a Contributor
All information on how to become a contributor is in our [Contribution Guidelines.](CONTRIBUTING.md)
## Feedback
We :heart: feedback!
##### Join the discussion in our [community chat.](https://decoslackin.herokuapp.com)
## Copyright
Copyright 2015 © Deco Software Inc - All rights reserved