ShipStation

ShipStation, https://shipstation.ai is an AI based portfolio management service. You can generate a personal website of your design requirements and manage/update it in natural langauge with chat mode.

Features of ShipStation.ai

• User authentication (login/signup) via SupaBase
• Dashboard to generate portfolio
• View previously generated portfolio with code editor to edit the generated website
• Real-time progress tracking during website generation on websocket

Project Architecture

The project is a full stack application

1. Server-side (Node.js) - located in the server folder.
2. 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
• Paypal account (for payment integration) or can use Razorpay or skip it all together

Setup Instructions

Clone the repository and follow the instructions below:

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

Supabase setup

1. Create a new project in Supabase
2. 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:

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

Server Setup

1. Install server dependencies:

   npm install

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

   npm run dev

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

   cd client
   npm install

5. Start the frontend dev server from the client directory

   npm run dev

6. Build the client if needed for deployment

   cd client
   npm run build

Usage

1. Access the application through the browser (default: http://localhost:5173)
2. Sign up or log in to your account
3. Provide portfolio details like name, profession and a design prompt

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

Deploying

1. Build the client project

   cd client
   npm run build

2. Commit the changes
3. Push to the main branch
4. 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.