updated parts of README.md
This commit is contained in:
parent
36a8bba6d9
commit
31c2d4ee3b
58
README.md
58
README.md
@ -1,29 +1,43 @@
|
||||
# APEX_test_application
|
||||
Testing version control for apex apps
|
||||
Scripts for bringing Oracle Application Express applications into version control, any version control tool may be used. Scripts designed to work for Linux and OSX (Will not work on Windows)
|
||||
|
||||
## Setup
|
||||
ensure apex is installed at /usr/local/apex
|
||||
Ensure you have ojdbc6.jar at $ORACLE_HOME/jdbc/lib
|
||||
clone the project
|
||||
Create an empty app in apex to get an app id create a config file in ./scripts
|
||||
#### Required files and environment variables
|
||||
|
||||
##TODO remove all make references in the project
|
||||
## Makefile Commands
|
||||
##### make help
|
||||
Display this help text
|
||||
##### make todo
|
||||
Show all lines which contain TODO in the project
|
||||
##### make apex-to-file
|
||||
#### Setting up required scripts
|
||||
|
||||
#### Grabbing the export file
|
||||
|
||||
#### Splitting the export file
|
||||
|
||||
#### Importing into Apex
|
||||
|
||||
## npm scripts Commands
|
||||
##### npm run apex-to-file
|
||||
Turn your apex workspace project into a file directory suitable for version control tools
|
||||
##### make file-to-apex
|
||||
Import your file directory into apex as an apex application
|
||||
##### make uninstall-apex
|
||||
##### npm run file-to-apex
|
||||
Import your file directory into apex as an apex application. This command will only work with a $PROJECT_HOME/apex/ dir which was generated by APEXExportSplitter
|
||||
##### npm run uninstall-apex
|
||||
Uninstall your app from apex
|
||||
##### make create-new-app
|
||||
Used for creating an entirely new instance of the app, should only be used when creating a new app instance for a new team member or for reinstalling the app
|
||||
##### make new-config-file
|
||||
Creates a new config file
|
||||
##### make switch-config-file
|
||||
##### npm run create-new-app
|
||||
Currently not an availible command, may be added in the future.
|
||||
##### npm run new-conf-file
|
||||
Creates a new config file using user input. NOTE: As of right now you must run 'npm run switch-conf-file' command to change to the new config file after creating a new one
|
||||
##### npm run switch-conf-file
|
||||
Switches which config file is being used
|
||||
##### make which-config-file
|
||||
Outputs the name of the config file currently being used
|
||||
##### npm run read-conf-file
|
||||
Outputs the name and contents of the config file currently being used
|
||||
|
||||
###Config File Explained
|
||||
May later add this section explaining each of the config parameters
|
||||
|
||||
###Known Issues
|
||||
#### Deleting a page will always win merges
|
||||
**To Reproduce**:
|
||||
* Have two developers working on different versions of an app (i.e. working on different features to be
|
||||
* Developer 1 deletes a page in the app and pushes to the project's repo
|
||||
* Developer 2 merges developer 1's changes and decides to keep the deleted page in the merge
|
||||
* When developer 2 reinstalls the app into apex the page will still be deleted
|
||||
**Why it occurs**
|
||||
*
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user