Skip to content
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.

Sign up for GitHub

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

Spruce up installation instructions #109

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Spruce up installation instructions #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 17 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,15 @@
source ENV/bin/activate
```

5. Navigate to the arches-rdm package, and install it into the virtual environment:
5. Navigate to the `arches-lingo` directory, and install the project (with development dependencies):
```
cd arches
pip install -e .
cd arches-lingo
pip install -e '.[dev]'
```

6. Navigate to the arches_lingo, and install the python requirements:
6. Also install core arches for local development:
```
cd ../arches-lingo
pip install -r arches_lingo/install/requirements.txt
pip install -e ../arches
Comment on lines -33 to +41
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reversed the order of these commands because doing it in the other order will undo your editable install of arches.

```

7. Run the Django server:
Expand All @@ -54,9 +53,8 @@
source ENV/bin/activate
```

10. Navigate to your project then install the frontend dependencies.
10. (From the `arches-lingo` top-level directory) install the frontend dependencies:
```
cd arches-lingo/
npm install
```

Expand All @@ -68,21 +66,27 @@

12. If you ran `npm start` in the previous step, you will need to open a new terminal window and activate the virtual environment in the new terminal window. If you ran `npm run build_development` then you can skip this step.

13. Navigate to the arches_lingo top-level directory, and install the ontologies, branches, and resource models from the arches-rdm package.
13. Install the ontologies, branches, and resource models from the package.
```
python manage.py setup_db
python manage.py packages -o load_package -s arches_lingo/pkg --yes -db
python manage.py packages -o load_package -a arches_lingo --yes -db
```

14. Load the test data:
```
python manage.py packages -o import_business_data -s tests/fixtures/data/aat_entries_scheme_examples.json -ow overwrite
python manage.py packages -o import_business_data -s tests/fixtures/data/aat_entries_concept_examples.json -ow overwrite
```

14. In the terminal window that is running the Django server, halt the server and restart it.
15. 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
```

## Committing changes

NOTE: Changes are commited to the arches-rdm repository.
NOTE: Changes are committed to the arches-lingo repository.

1. Navigate to the repository
```
Expand All @@ -91,7 +95,7 @@ NOTE: Changes are commited to the arches-rdm repository.

2. Cut a new git branch
```
git checkout origin/master -b my-descriptive-branch-name
git checkout origin/main -b my-descriptive-branch-name
```

3. If updating models or branches
Expand Down