shipfast

(β˜… 550)

The best free SaaS base for GenAI, LLM, and other AI Services. Ship your next Generative AI startups in days.

  • .env.shared
  • .env.test
  • .eslintignore
  • .eslintrc.json
  • .gitignore
  • .graphqlconfig
  • .lintstagedrc
  • .prettierignore
  • .prettierrc
  • .versionrc.js
  • babel.config.json
  • bitbucket-pipelines.yml
  • docker-compose.ci.yml
  • docker-compose.local.yml
  • docker-compose.yml
  • jest.config.ts
  • jest.preset.js
  • LICENSE
  • LICENSE-saas-boilerplate
  • nx.json
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • tailwind.workspace-preset.ts
  • tsconfig.base.json

# Installation Guide

1. Get the code
git clone https://github.com/vietanhdev/shipfast

Downloads the entire project code from GitHub to your computer.

cd shipfast

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.ci.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm shipfast up

Type this command into your terminal and run it.

pnpm shipfast backend up

Type this command into your terminal and run it.

pnpm shipfast webapp up

Type this command into your terminal and run it.

pnpm shipfast docs up

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install .

Installs the package published on PyPI directly β€” no need to clone the source.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation