Table of Contents
Spindle is a developer automation tool which parses your Mongoose schema to create meaningful external facing APIs for your business. Spindle completely hosts your APIs through clever database design and virtual machines. This tool is perfect for businesses with large amounts of data it wishes to expose to users without wasting resources to create low level APIs.
This project runs NextJS 13 for the frontend and ExpressJS with NodeJS on the backend.
- npm
npm install npm@latest -g
-
Get a free API Key at https://example.com
-
Clone the repo
git clone https://github.com/mnshah0101/spindle.git
-
Cd to spindle
cd spindle-
Install NPM packages
npm install
-
Cd to server
cd.. cd server -
Install NPM packages
npm install
-
Enter your API in
.envAPI_KEY = MY_KEY;
Spindle is perfect for businesses looking to create an API for their database, without the hassle and repitition of manually defining endpoints. Simply input a natural language query for what functionalities you'd like your API to have, as well as your database's URI, and your API is ready to ship.
- API Hosting
- Support for additional databases
- Both SQL and NoSQL
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Contact us at team@spindle.com
Project Link: https://github.com/mnshah0101/spindle