Installation

Installation guide for NeoSaaS.

Prerequisites

To get started with NeoSaaS, ensure you have the following prerequisites installed:

  • Node.js 18.x or later
  • NPM
  • Stripe account for accepting payments

To set up NeoSaaS, first buy the boilerplate from this link.

Then, using the access you've been given, go to the Releases section of the GitHub repository and download the latest version to your computer.

Run application

Warning:

To get the required .env keys for NeoSaaS to run properly, check the section in the left menu to configure this keys and database.

To get started, you can clone the AriaDocs repository directly from GitHub.

1
Unzip the downloaded `.zip` file into a folder of your choice.
2
Next, open the project folder in your favorite IDE (Cursor, Windsurf, VS Code, etc.).
3
Copy the .env.example file and rename it to .env

After opening the project, copy the .env.example file and rename it to .env with just copy paste or with this code in terminal.

cp .env.example .env
4
Replace the placeholder values inside `.env` with your actual environment-specific credentials.
.env
# Change this lines with your actual keys

# Your Supabase keys
NEXT_PUBLIC_SUPABASE_URL="your_supabase_url"
NEXT_PUBLIC_SUPABASE_ANON_KEY="your_supabase_anon_key"

SUPABASE_URL="your_supabase_url"
SUPABASE_SERVICE_ROLE_KEY="your_supabase_service_role_key"

# Your website url without "/" in the end
NEXT_PUBLIC_APP_URL="http://localhost:3000"

# Your Stripe test keys. Don't forget to use live keys on production
STRIPE_SECRET_KEY="sk_test_..."
STRIPE_WEBHOOK_SECRET="whsec_..."
5
Install dependencies

Run npm install on terminal to install all dependencies.

npm install
6
Start the application

Finally, start the development server with npm run dev to begin testing the project locally.

npm run dev

You're all set!:

NeoSaaS is now running locally — start customizing, name your SaaS, add great functions and ship it!