ShipStation

ShipStation, https://shipstation.ai is an AI based website and agents generation platform.

To begin with, we are optimising simple landing page websites, next stop being generic connect-anything-to-anything services.

Imagine working on some new platform which has solved a lot of good problems but just doesn't work effectively for you as the provider of the service can't understand you and you can't understand the provider.

Our WIP tool is able to solve it with very high accuracy, say 95% of the time so that you, the saas provider and the required integration partner never need to be aware of each other and things get done for you.

Features of ShipStation

User authentication (login/signup) via SupaBase
Basic landing page to communicate with user and understand what would make them happy
View previously generated projects and featured websites
Code editor to edit the generated website
Option to use personal Anthropic API key for free usage
Integrated payment options via Razorpay/PayPal for purchasing credits. Paypal integration is not complete yet.
Real-time progress tracking during website generation on websocket

Project Architecture

The project is a full stack application

Server-side (Node.js) - located in the server folder.
Client-side (React with Vite) - located in the client folder.

Prerequisites

Node.js (v20 or later recommended)
npm or yarn
Anthropic API key
Supabase account (for auth and more)
Tavily API key
Razorpay account (for payment integration) or can use stripe or skip it all together
Heroku for the server (for deploying shipstation itself) - mainly due to bucketeer addon
Bucketeer Heroku Addon for storing and retrieving the generated website - can use any other S3 compatible storage

Setup Instructions

Clone the repository and follow the instructions below:

git clone https://github.com/daytimedrinkingclub/shipstation-backend.git

Supabase setup

Create a new project in Supabase
Copy SQL from the server/setup.sql file and run it in the SQL editor https://supabase.com/dashboard/project/[your-project-id]/sql/new

Environment Variables

Ensure all environment variables are properly set in both .env files. Refer to the .env.template files for the required variables.

There are three env files that need to be created:

Backend .env from .env.template in root folder.
Frontend .env.local from .env.template in client directory
Frontend .env.production from .env.template in client directory. This will be used while creating production build

Server Setup

Install server dependencies:

npm install

Setup environments: Copy .env.template to .env and fill in the required environment variables. Read the comments in the template file for more details.
Start the backend server from the repo directory

npm run dev

In a new terminal, navigate to the client directory and install the frontend dependencies

cd client
npm install

Start the frontend dev server from the client directory

npm run dev

Build the client if needed for deployment

cd client
npm run build

Usage

Access the application through the browser (default: http://localhost:5173)
Sign up or log in to your account
Choose between creating a landing page or portfolio
Add the details for getting a website as output.

The websites are stored in s3 bucket and served on the path https://shipstation.ai/site/website-slug

Deploying to Heroku

Build the client project

cd client
npm run build

Commit the changes
Push to the main branch
Heroku will automatically detect the changes and deploy the app

Next moves

Since you came here looking for it, it was also waiting for you to contribute to the project. As for the next rabbithole, visit https://freeaifinder.com We all are limited by the desire to learn things and energy to validate. Thankfully, we are making it easier for you.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

Do good, be good.

Vishvsalvi/shipstation