Skip to content
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ _site/
.venv/

/.quarto/
venv/
79 changes: 78 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Connecting open science projects

A centralized platform with a searchable database and news feed could greatly improve the discoverability of the open source ecosystem.
A centralized platform with a searchable database and news feed to improve the discoverability of the open source ecosystem.

## Why?

Expand All @@ -13,3 +13,80 @@ A centralized platform with a searchable database and news feed could greatly im
## Who?

Current contributors seeking projects or collaborators, new contributors exploring opportunities, and project leads looking for contributors and partners.

## Setup Instructions

### Prerequisites
- Python 3.11 or higher

### Installation

1. Clone this repository:
```
git clone https://github.com/OpenScienceLabs/connecting-osp.git
cd connecting-osp
```

2. Create and activate a virtual environment using uv:
```
uv venv
source .venv/bin/activate # On Unix or macOS
# OR
.venv\Scripts\activate # On Windows
```

3. Install the project dependencies:
```
uv pip install -r pyproject.toml
```

### Running the Project

#### Using Quarto (Recommended)

With the virtual environment activated:

```
quarto preview
```

The website will be available at http://localhost:7719/ (or similar port).

#### Using Jupyter Lab (Alternative)

With the virtual environment activated:

```
jupyter lab
```

This will open a Jupyter Lab instance in your browser where you can explore and edit the project files. The Jupyter server typically runs at:
- http://localhost:8888/lab (a token will be provided in the terminal output)

## Project Structure

- `_quarto.yml` - Quarto configuration file
- `index.qmd` - Homepage
- `projects.qmd` - Projects listing
- `news.qmd` - News feed
- `about.qmd` - About page
- `styles.css` - Custom styles
- `images/` - Image assets
- `data/` - Data files

## Troubleshooting

### Common Issues

1. **"Module not found" errors**: Make sure your virtual environment is activated and dependencies are installed:
```
source .venv/bin/activate # On Unix or macOS
# OR
.venv\Scripts\activate # On Windows
uv pip install -r pyproject.toml
```

2. **Quarto not found**: The quarto-cli package should install Quarto automatically. If you have issues, try reinstalling the package:
```
uv pip install --force-reinstall quarto-cli
```