Jarvan-via/api-service

Provide OpenAI related API for businesses, as well as other AI related APIs

API-SERVICE

Provide OpenAI API for services, and subsequently access more AI-related API

Currently Implemented Functions

API-DOC

Table of Contents

• Prerequisites
• Install
• Usage
• Deploy On Unix Platform
• Check Your Service
• Maintainers
• Contributing
• License

Prerequisites

Node >= 16
Recommend Node 18

Install

npm i 
npm i nodemon -g
npm i typescript -g

Usage

touch .env

#.env
PORT=8080
REDIS_HOST=127.0.0.1
REDIS_PORT=6379

npm run start

Deploy On Unix Platform

touch .env

#.env
PORT=8080
REDIS_HOST=127.0.0.1
REDIS_PORT=6379

npm i pm2 -g
tsc
NODE_ENV=prod pm2 start build/main.js --name=api-service

Check Your Service

curl --location --request GET 'http://localhost:8080/ping'

Maintainers

@Jarvan-via

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

GPL © 2023 Jarvan-via