Skip to content

Commit

Permalink
Add a readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robertDouglass committed Jul 17, 2024
1 parent 4f0dcc0 commit 855ec07
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# On Upsun

Welcome to the "On Upsun" project! This repository contains Hugo pages that illustrate how to set up and deploy Django projects on the Upsun Platform-as-a-Service (PaaS) by Platform.sh. The tutorials cover various configurations, including using SQLite and PostgreSQL with the PGVector extension for advanced database functionalities.

## Contents

- **Install Django with SQLite on Upsun**: Basic setup of Django using SQLite on Upsun.
- **Install Django with PostgreSQL and PGVector on Upsun**: Advanced setup with PostgreSQL and PGVector for semantic queries and Retrieval Augmented Generation (RAG) with Large Language Models (LLM).

## Prerequisites

- Git
- Python 3
- Pip
- Homebrew (for macOS users)
- Upsun CLI

## Tutorials

### 1. Install Django with SQLite on Upsun

This tutorial walks you through setting up a basic Django project with a SQLite database on Upsun. It covers:
- Environment preparation
- Django project setup
- Git integration
- Upsun CLI installation
- Configuring Upsun for deployment
- Creating an admin user

For detailed steps, refer to the [Install Django with SQLite on Upsun tutorial](https://github.com/robertDouglass/on_upsun/tree/main/01_install_django_sqlite_upsun).

### 2. Install Django with PostgreSQL and PGVector on Upsun

This advanced tutorial demonstrates how to configure a Django project to use PostgreSQL and the PGVector extension on Upsun. It includes:
- Environment setup and project initialization
- Making the project compatible with Upsun
- Using Git for deployment
- Interacting with PostgreSQL
- Installing and testing the PGVector extension

For detailed steps, refer to the [Install Django with PostgreSQL and PGVector on Upsun tutorial](https://github.com/robertDouglass/on_upsun/tree/main/02_install_django_postgresql_pgvector_upsun).

## Getting Started

### Clone the Repository

```bash
git clone https://github.com/robertDouglass/on_upsun.git
cd on_upsun

## Contact me

If you have any questions, my email address is [email protected] and you can [find me on LinkedIn](https://www.linkedin.com/in/roberttdouglass/). There is also an [Upsun Discord forum](https://discord.gg/PkMc2pVCDV) where I hang out, and you're welcome to find me there.

0 comments on commit 855ec07

Please sign in to comment.