HackBase/apex-source-control
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:ntreeinc/apex-source-control

Browse Source
This commit is contained in:
Nathan Farrant-Diaz 2016-06-07 13:52:54 -04:00
commit 7239e62d49
1 changed files with 8 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -16,13 +16,10 @@ Prerequisites:
## Usage
#### Bring an existing APEX app into source control
1) Make a local directory for your app and in the new directory run npm init and follow the given prompts
1) Make a local directory for your app and in the new directory run `npm init` and follow the given prompts
2) Add the following lines to your devDependencies in package.json (Note: delete or repurpose the pre-existing scripts value)
"devDependencies": {
"apex-source-control" : "git+ssh://git@github.com:ntreeinc/apex-source-control.git"
},
"scripts": {
"apex-to-file" : "apex-source-control apex-to-file",
"file-to-apex" : "apex-source-control file-to-apex",
@ -37,24 +34,19 @@ If you want you can change the npm run commands (under scripts) to anything you'
3) Run the following commands and follow the prompts. The app id, parsing_schema, workspace_name and database connection info should all correspond to the app you want to download (see <a href="#configuration">Configuration</a>)
npm install
cd node_modules/apex-source-control
npm link
npm install --save-dev apex-source-control
npm run new-conf-file #create a config file with the info of the app you want to download
npm run switch-conf-file #unnecessary if you choose to switch to your new config file in npm run new-conf-file
npm run switch-conf-file #unnecessary if you choose to switch to your new config file in npm run in previous command
npm run apex-to-file #download the app locally
You can now set up the application as a git or other version-control repository. Be warned that if you downloaded the app from another developer's copy of the app, or some other version of the app you don't want to overwrite, you should create a new config file and set up a new version of the application.
#### Setting up from an APEX export file
1) Make a local directory for your app and in the new directory run npm init and follow the given prompts
1) Make a local directory for your app and in the new directory run `npm init` and follow the given prompts
2) Add the following lines to your devDependencies in package.json (Note: delete or repurpose the pre-existing scripts value)
"devDependencies": {
"apex-source-control" : "git+ssh://git@github.com:ntreeinc/apex-source-control.git"
},
"scripts": {
"apex-to-file" : "apex-source-control apex-to-file",
"file-to-apex" : "apex-source-control file-to-apex",
@ -67,15 +59,11 @@ You can now set up the application as a git or other version-control repository.
If you want you can change the npm run commands (under scripts) to anything you'd like (see <a href="#npm-scripts-commands">npm scripts Commands</a>).
3) Run:
npm install
cd node_modules/apex-source-control
npm link
3) Run `npm install --save-dev apex-source-control`
5) Copy the export file into your project directory
6) Set up your classpath and run APEXExportSplitter
6) Set up your classpath and run APEXExportSplitter on the export file
export CLASSPATH=$APEX_HOME/utilities:$ORACLE_HOME/jdbc/lib/ojdbc6.jar
java oracle.apex.APEXExportSplitter $export_file
@ -90,7 +78,7 @@ The CLASSPATH variable does not need to be added to your bash profile
We do this because we need to set the relative path to the install components from the top level directory
9) Remove the old $export_file or place it in a different directory
9) Remove the old `$export_file` or place it in a different directory
From here you can now either set up the project as a git/subversion/etc. repository or install into apex using:
@ -102,7 +90,7 @@ From here you can now either set up the project as a git/subversion/etc. reposit
1) Clone the repository locally
2) Use 'npm install' to install dependencies
2) Use `npm install` to install dependencies
3) Run the following commands and follow the prompts. This will set up your config file and put the application into your APEX workspace