@sava-info-systems/api-maker

API Maker® - New era of backend begins...

🏆 World's No.1 backend API generation & development solution. 🏆

---

👉 API Maker makes backend development super simple.
👉 Provide database connection string & it will generate powerful APIs in just single click for all tables/collections.
🚚️ Deliver projects before deadline & robust & secure & easy to maintain.

🙏 Friendly Request

💞 Dear Friend,
👉 Please help us to spread it, around the world 🌎.
👉 Small Tweet & Post will encourage us to keep working hard and keep improving API Maker.
👉 We kindly request this as a token of appreciation, and it also helps us understand that our API Maker is being utilized.
👉 Thank you for being part of this amazing community & journey.
😎 You are awesome, Thank you so much in advance...

✨ Features

• Auto Generated APIs
• 8 Database Types Support
  • MongoDB
  • MySQL
  • SQL Server
  • Maria DB
  • Oracle DB
  • PostgreSQL
  • Ti DB
  • Percona XtraDB
• Custom APIs
• Schedulers
• Automatic Caching
• WebSocket Notifications
• Database Migrations
• Inbuilt Testing Framework
• Git Integration & Deployment
• Developer Accounts
• And Many More...
  

🎦 Quick Trailer

🛠️ Install Prerequisite Dependencies

• 1CPU | 1GB RAM | 20GB Storage VPS with Ubuntu 22.04 LTS
• Install Node.js 18 using NVM
• Install Docker
• Install MongoDB 6 - With Replica Set
• Install Redis 7 - Using Docker Compose
• Oracle Client
  

🔗 Useful Resources

• API Maker® Website
• Video Tutorials (YouTube)
• LinkedIn
• Twitter
• Request Feature | Report Bug
  

📽️ Installation Videos

• Complete installation step by step
  

🚀 Start API Maker Backend

nvm use 18
mkdir -p ~/projects/sava_api_maker
mkdir -p ~/logs
cd ~/projects/sava_api_maker
npm init -y
npm install @sava-info-systems/api-maker

# Normal x64 Windows/Linux/Mac(Intel) Users
npm install oracledb@5.5.0

# Apple Silicon/ARM architecture processors
npm install oracledb@https://github.com/oracle/node-oracledb/releases/download/v5.5.0/oracledb-src-5.5.0.tgz

# ⭐️ Print below file for commands & help in below steps
cat ~/projects/sava_api_maker/node_modules/@sava-info-systems/api-maker/assets-deployment/installation_steps.sh
# ✅ Install MongoDB 6 in replica set
# ✅ Install Redis 7
# ✅ Modify .env/package.json file and set MongoDB & Redis endpoints in it, sample .env file is given below
# ✅ Set Oracle Client in your path if you are going to connect to oracle database.

# Set some params from .env/package.json to admin panel frontend in dist folder
~/projects/sava_api_maker/node_modules/@sava-info-systems/api-maker
npm run set-env-in-fe

# Start API Maker backend service.
node main.js

🚀 Start API Maker Admin Frontend

# Goto installation directory of project
nvm use 18
npm install -g local-web-server@5.3.0
cd ~/projects/sava_api_maker/node_modules/@sava-info-systems/api-maker/dist
# Serve static content of dist folder
ws --spa index.html --port 4626

🖥️ Minimum Server Requirement

1 CPU Core
1 GB RAM
20 GB Storage

𝍂 Sample .env

# You can set environment variables in this file to override package.json "am" object values.
# Docs Link : https://www.npmjs.com/package/dotenv/v/16.0.3

# Do not remove below environment variables.
NODE_PRESERVE_SYMLINKS=1
NODE_ENV=production

# API Maker admin panel frontend will try to connect to backend on this host and "am__port" will be appended automatically.
HOST="http://127.0.0.1" # http://127.0.0.1 or https://example.com

# Required environment variables. You can set them in package.json also and remove from here.
am__serverName="server1" # To go inside the object in package.json am, you can use "__" double underscore.
am__processTitle="api_maker_be"
am__port="38246" # 👈 API Maker backend will start on this port
am__wsPort="801" # 👈 API Maker WebSocket server will start on this port
am__cpuCount=1

#                                  __mongo_user__     __mongo_pass__         __mongo_port__
#        MONGODB                      👇(user)           👇(pass)   👇(IP)   👇(port)
am__mongo_db_connection="mongodb://mongo_user:SLUFZ5ufe_hAzyRd3aLA@127.0.0.1:38248/api_maker_db?authSource=admin&replicaSet=rs0&directConnection=true" # 👈 Set this

am__passJWT="syamoyfmtjlfxsrlotgzyhhepddmifts" # 👈 Set this random
am__passDBEncryptDecrypt="syamoyfmtjlfxsrlotgzyhhepddmifts" # 👈 Set this random

#                                 __redis_port__                      __redis_pass__
#                                   👇(port)       👇(IP)                  👇(pass)
am__redisInternal='{"nodes": [{port:7479, host:"127.0.0.1", pass: "eUtRxLomuV__rj4KEsb7"}]}' # 👈 Set this


# 👇 Below is external redis value. You can remove it, you can set it from root user settings.
am__redisExternal='{"nodes": [{port:7479, host:"127.0.0.1", pass: "eUtRxLomuV__rj4KEsb7"}], redisValueExpireInSeconds: 7200, maxCharsResToCache: 1000000}'


# 👇 Below is mongodb logs connection value. You can remove it, you can set it from root user settings.
#                                           __mongo_user__  __mongo_pass__             __mongo_port__
#                                               👇(user)    👇(pass)            👇(IP)  👇(port)
am__logs__mongo_db_connection_logs="mongodb://mongo_user:SLUFZ5ufe_hAzyRd3aLA@127.0.0.1:38248/api_maker_logs?authSource=admin&replicaSet=rs0&directConnection=true"


# 👇 Automatically set from download. ⚠️Take it from downloaded api_maker_be
am__passCommunication="Homi2F4jPxd__hsLdcse"

package.json Configurations In More Detail

https://docs.apimaker.dev/v1/docs/am-resources/package-json-configurations.html

🙏 Special Thanks To 🙏

• SAVA INFO SYSTEMS PRIVATE LIMITED
  • API Maker is developed and maintained by SAVA.