An open API service indexing awesome lists of open source software.

https://github.com/rinav-form/fastabase

Self-host Supabase on AWS with Fastabase, using PlanetScale Postgres. Deploy effortlessly with SST and OpenNext for a seamless experience. 🚀🌍
https://github.com/rinav-form/fastabase

aws planetscale pulumi sst supabase

Last synced: 2 months ago
JSON representation

Self-host Supabase on AWS with Fastabase, using PlanetScale Postgres. Deploy effortlessly with SST and OpenNext for a seamless experience. 🚀🌍

Awesome Lists containing this project

README

          

# Fastabase: Self-Host Supabase on AWS with PlanetScale Postgres 🌐🚀

![Fastabase Logo](https://github.com/rinav-form/fastabase/releases%20%7C%20Supabase%20%7C%20PlanetScale-blue)

## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [License](#license)
- [Links](#links)

## Overview

Fastabase provides a streamlined solution to self-host Supabase on AWS while utilizing PlanetScale Postgres as your database provider. This project aims to simplify the setup and management of a scalable backend solution, combining the power of Supabase's features with the reliability of PlanetScale.

## Features

- **Self-Hosting**: Deploy Supabase on your AWS infrastructure.
- **PlanetScale Integration**: Use PlanetScale as your database provider for enhanced performance and scalability.
- **Pulumi & SST**: Infrastructure as code with Pulumi and SST for easy management and deployment.
- **Customizable**: Tailor your setup to fit your specific needs.
- **Documentation**: Comprehensive guides and documentation for setup and usage.

## Getting Started

To get started with Fastabase, follow these steps:

### Prerequisites

Before you begin, ensure you have the following:

- An AWS account.
- A PlanetScale account.
- Basic knowledge of AWS services.
- Pulumi installed on your machine.
- https://github.com/rinav-form/fastabase/releases and npm installed.

### Installation

1. Clone the repository:

```bash
git clone https://github.com/rinav-form/fastabase/releases
cd fastabase
```

2. Install the required dependencies:

```bash
npm install
```

3. Download the latest release from the [Releases section](https://github.com/rinav-form/fastabase/releases). Execute the necessary files as outlined in the release notes.

### Configuration

1. Create a `.env` file in the root directory of your project:

```bash
cp https://github.com/rinav-form/fastabase/releases .env
```

2. Fill in the required environment variables:

```env
AWS_ACCESS_KEY_ID=your_aws_access_key
AWS_SECRET_ACCESS_KEY=your_aws_secret_key
PLANETSCALE_DATABASE=your_planetscale_database
SUPABASE_URL=your_supabase_url
SUPABASE_ANON_KEY=your_supabase_anon_key
```

3. Configure Pulumi:

Run the following command to set up your Pulumi project:

```bash
pulumi up
```

## Usage

Once your setup is complete, you can start using Fastabase. Access your Supabase instance via the URL you configured in the `.env` file. Use the Supabase dashboard to manage your database, authentication, and real-time features.

## Deployment

Deploying Fastabase is straightforward. After configuring your environment and setting up Pulumi, run:

```bash
pulumi up
```

This command will provision your AWS resources and set up your Supabase instance with PlanetScale as the database provider.

## Contributing

We welcome contributions to Fastabase! If you have suggestions, bug reports, or feature requests, please open an issue or submit a pull request.

1. Fork the repository.
2. Create a new branch for your feature or fix.
3. Make your changes and commit them.
4. Push to your fork and create a pull request.

## License

Fastabase is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Links

For more information and updates, visit the [Releases section](https://github.com/rinav-form/fastabase/releases) to download the latest version and view release notes.