Getting Started with InceptTools

Learn the basics of InceptTools and how to get started with our libraries.

What is InceptTools?

InceptTools is a collection of open-source libraries designed to simplify development with automation, unified APIs, and developer-friendly tools. Our libraries help you build better applications faster by providing solutions to common development challenges.

@inceptools/db

A modular database adapter for MongoDB, SQL (Sequelize), and Redis with a unified API.

Learn More

@inceptools/cli

Command-line tools to automate development processes (coming soon).

Learn More

Installation

You can install InceptTools libraries using npm, yarn, or pnpm:

npm install @inceptools/db

For more detailed installation instructions, see the Installation Guide.

Quick Start

Here's a simple example of how to use @inceptools/db with MongoDB:

import { MongoService, SUPPORTED_DBS } from "@inceptools/db";
import mongoose from "mongoose";

// Define your MongoDB schemas
const schemas = {
  users: new mongoose.Schema({
    name: String,
    email: String,
    createdAt: { type: Date, default: Date.now },
  }),
};

// Create a MongoDB service instance
const mongoService = new MongoService({
  type: SUPPORTED_DBS.MONGO_DB,
  connectionString: "mongodb://localhost:27017/myapp",
  models: schemas,
});

// Connect to MongoDB
await mongoService.connect();

// Use your models
const users = await mongoService.users.find();

// Close the connection when done
await mongoService.closeConnection();

Next Steps

Now that you've learned the basics, explore our product-specific documentation:

@inceptools/db Documentation

@inceptools/cli Documentation

Best Practices

Join Our Community

Get help, share your projects, and contribute to the InceptTools ecosystem.

GitHub Join Community