-
Download the arches_rdm_example_project:
a. If using the Github CLI:
gh repo clone archesproject/arches_rdm_example_project
b. If not using the Github CLI:
git clone https://github.com/archesproject/arches_rdm_example_project.git
-
Download the arches-rdm package:
a. If using the Github CLI:
gh repo clone archesproject/arches-rdm
b. If not using the Github CLI:
git clone https://github.com/archesproject/arches-rdm.git
-
Create a virtual environment outside of both repositories:
python3 -m venv ENV
-
Activate the virtual enviroment in your terminal:
source ENV/bin/activate
-
Navigate to the arches-rdm package, and install it into the virtual environment:
cd arches-rdm pip install -e .
-
Navigate to the arches_rdm_example_project, and install the python requirements:
cd ../arches_rdm_example_project pip install -r arches_rdm_example_project/install/requirements.txt
-
Run the Django server:
python manage.py runserver
-
OPEN A NEW TERMINAL WINDOW, the following step will take place in a new terminal window while the python server is running.
-
Ensure this new terminal window has the virtual environment activated.
source ENV/bin/activate
-
Navigate to the
arches_rdm_example_project
folder in your project, you should be at the same level aspackage.json
. Then install the frontend dependencies.cd arches_rdm_example_project/arches_rdm_example_project yarn install
-
Once the dependencies have been installed, generate the static asset bundle:
a. If you're planning on editing HTML/CSS/JavaScript files, run
yarn start
. This will start a development server that will automatically detect changes to static assets and rebuild the bundle.b. If you're not planning on editing HTML/CSS/JavaScript files, run
yarn build_development
-
(optional) If you ran
yarn start
in the previous step, you will need to open a new terminal window and activate the virutal environment in the new terminal window. -
Navigate to the arches_rdm_example_project top-level directory, and install the ontologies, branches, and resource models from the arches-rdm package.
python manage.py setup_db python manage.py packages -o load_package -s ../arches-rdm/arches_rdm/pkg --yes -db
-
In the terminal window that is running the Django server, halt the server and restart it.
(ctrl+c to halt the server) python manage.py runserver
NOTE: Changes are commited to the arches-rdm repository.
-
Navigate to the repository
cd arches-rdm
-
Cut a new git branch
git checkout origin/master -b my-descriptive-branch-name
-
If updating models or branches
-
Manually export the model or branch from the project
-
Manually move the exported model or branch into one of the subdirectories in the
arches-rdm/arches_rdm/pkg/graphs
directory.
-
-
Add your changes to the current git commit
git status git add -- path/to/file path/to/second/file git commit -m "Descriptive commit message"
-
Update the remote repository with your commits:
git push origin HEAD
-
Navigate to https://github.com/archesproject/arches-rdm/pulls to see and commit the pull request