Skip to content
Open
Changes from all commits
Commits
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
85 changes: 59 additions & 26 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,67 @@
# Install overview
This project currently only works with `python 2` and very old django version `django < 1.9`.
This instructions show how to setup a local virtual environment.
# Cytoscape App Store – Local Development Setup

## Checkout code base
```
git clone https://github.com/cytoscape/appstore.git CyAppStore
```
The root folder must be named `CyAppStore` so that the relative imports are working.
## Requirements

## Additional requirements
- mysql
- xapian (https://xapian.org/docs/install.html, https://github.com/notanumber/xapian-haystack/blob/master/install_xapian.sh)
- Python 3.9+
- pip
- virtual environment
- MySQL
- Xapian

The project currently runs on **Django 4.2**.

---

## Setup Virtual Environment
```
mkvirtualenv appstore --python=python2
(appstore) ./install_xapian.sh 1.4.5
(appstore) pip install gevent
(appstore) pip install -r requirement.txt
```
## 1. Clone the Repository

## Perform the migrations
```
(appstore) python manage.py migrate
```
git clone https://github.com/cytoscape/appstore.git
cd appstore

## Test the server
```
(appstore) python manage.py runserver
```
---

## 2. Create Virtual Environment

python3 -m venv venv
source venv/bin/activate

---

## 3. Install Dependencies

Install all required Python packages:

pip install -r requirements.txt

---

## 4. Install Xapian (search backend)

./install_xapian.sh 1.4.5

---

## 5. Run Database Migrations

python manage.py migrate

---

## 6. Run the Development Server

python manage.py runserver

The server will start at:

http://127.0.0.1:8000/

---

## 7. Run Unit Tests

To verify the setup works correctly:

make test

or

python manage.py test