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

Jump to bottom

Adding installation instruction #50

Closed
wants to merge 2 commits into from
Closed

Adding installation instruction #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6ac07a
Adding installation instruction
lbonomo Sep 12, 2024
6479a1c
Update README.md
lbonomo Sep 12, 2024
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

# Build
/build/
/assets/

# Composer
/vendor/
Expand Down
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# Orbis

## Installation Process

### Clone the Repository
Navigate to the WordPress plugin directory and clone the repository:
```bash
git clone [email protected]:pronamic/wp-orbis.git wordpress/wp-content/plugins/
```

### Navigate to the Plugin Directory
Move into the newly created wp-orbis directory:

```bash
cd wordpress/wp-content/plugins/wp-orbis
```

### Install Composer Dependencies
Install PHP dependencies using Composer:

```bash
composer install
```

### Install NPM Dependencies
Install the required Node.js packages:

```bash
npm install
```

### Run Build Task
Copy assets and run any necessary build tasks:

```bash
npm run copy
```

## Conflict

### [WP Extended Search](https://wordpress.org/plugins/wp-extended-search/)
Expand Down