Getting Started

Installation on your own infrastructure

Deploy Singularities AI on your own infrastructure.
Local-First & Secure
Singularities AI runs all LLMs on your own infrastructure, ensuring data privacy and security.

Singularities AI is a feature-rich web platform for interacting with Ollama-powered text-based AI models. It is designed for both beginners and professionals, offering customization, role management, and a responsive interface.


Get the Source Code

Singularities AI is open source and available on GitHub. To get started, clone the repository:

Terminal
git clone https://github.com/Singularities-AI/singularities-ai.git
cd singularities-ai

Prerequisites

  • Ollama installed and running
  • Java 21 (for the Spring Boot API)
  • Node.js ≥ 20 (for the frontend)
  • pnpm ≥ 8 (for package management)
  • PostgreSQL ≥ 16 (for data persistence)

Installation

1. Set Up PostgreSQL

Install and start PostgreSQL. Create a new database and user for Singularities AI:

Terminal
sudo -u postgres psql -c "CREATE DATABASE singularities;"
sudo -u postgres psql -c "CREATE USER singularities WITH PASSWORD 'yourpassword';"
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE singularities TO singularities;"

2. Configure and Run the API

Clone the repository and navigate to the backend directory. Update the following properties in application.properties:

PropertyExample ValueDescription
singularities.app.jwtSecretyour_jwt_secretJWT secret for authentication
spring.mail.hostsmtp.example.comSMTP host for email
spring.mail.usernameuser@example.comSMTP username
spring.mail.passwordyourpasswordSMTP password
app.nameSingularities AIYour app name
app.urlhttp://localhost:8080API base URL
app.url.clienthttp://localhost:7000Frontend URL
spring.ai.ollama.base-urlhttp://localhost:11434Ollama server URL
spring.datasource.urljdbc:postgresql://localhost:5432/singularitiesPostgreSQL connection URL
spring.datasource.usernamesingularitiesPostgreSQL username
spring.datasource.passwordyourpasswordPostgreSQL password

Start the API:

Terminal
mvn spring-boot:run

3. Configure and Run the Frontend

Navigate to the frontend directory. Update the .env file:

.env
API_URL=http://localhost:8080

Install dependencies and start the frontend:

Terminal
pnpm install
pnpm dev
The frontend will be available at http://localhost:7000.

Configuration

API Configuration

You can customize the API behavior by editing application.properties. For example, to change the server port:

application.properties
server.port=8080

Frontend Configuration

Update the .env file to match your API URL and other environment variables as needed.


Support

For questions, suggestions, or assistance, open an issue or contact contact@singularities-ai.com.