generators
API Generator - instantly generate REST and GraphQL APIs (openapi (OAS) 3.0.0)
File Explorer
Download Latest Version (.zip)- config.js
- index.js
- index.js
- makeConfig.js
- create.js
- delete.js
- get.js
- getOne.js
- index.js
- indexFile.js
- makeAPI.js
- update.js
- createIndex.js
- createResolvers.js
- index.js
- makeGraphql.js
- tcString.js
- connectionIndex.js
- connectionMongo.js
- index.js
- makeConnection.js
- makeModelIndex.js
- makeSchema.js
- modelIndex.js
- connectionRedis.js
- index.js
- index.js
- indexCode.js
- makeRouter.js
- routerCode.js
- dockerFile.js
- eslint.json
- index.js
- package.json
- readme.js
- serverIndex.js
- userCan.js
- writeDockerIgnore.js
- writeEslint.js
- writeGitIgnore.js
- writePackageJSON.js
- index.js
- makeProperties.js
- makeSwaggerModelDefinitions.js
- safeDefault.js
- safeType.js
- schemaDefinition.js
- fakeObject.js
- genData.js
- graphqlSafe.js
- index.js
- makeGraphqlTests.js
- makeRestTests.js
- makeTests.js
- randomPropertyChange.js
- subDocHelper.js
- createUpdateCode.js
- createValidationCode.js
- extraParams.js
- getSchemaQueryDefinitions.js
- getSearchCode.js
- getValidationCode.js
- index.js
- returnValueBasedOnType.js
- sugarGenerated.js
- uppercase.js
- validateSchema.js
- makeApi.js
- createChipComponent.js
- createChipInputComponent.js
- createForm.js
- createSnackbar.js
- createTable.js
- getReactState.js
- getTableColumns.js
- makeComponents.js
- tagsComponent.js
- textFieldByType.js
- textFieldsByType.js
- typeToValue.js
- _app.js
- _document.js
- about.js
- index.js
- makePages.js
- apiCall.js
- Link.js
- makeSrc.js
- ProTip.js
- theme.js
- babelrc.js
- config.js
- dockerfile.js
- gitignore.js
- makeStatics.js
- next-config.js
- package.js
- readme.js
- makeApp.js
- createHTMLCreateForm.js
- createHTMLTable.js
- createJSCreateForm.js
- createJSTable.js
- makeEmbeddable.js
- app.json
- auth.json
- deployment.json
- device.json
- monkey.json
- multi.json
- secret.json
- simple.json
- user-can.json
- user.json
- .eslintrc
- .gitignore
- graphql-mutation.png
- graphql-schema.png
- graphql.png
- index.js
- License
- logo.png
- monkey.png
- package-lock.json
- package.json
- README.api.md
- README.app.md
- README.dev
- README.md
- start.png
- table-component.png
- user-form.png
# Installation Guide
1. Get the code
git clone https://github.com/wrannaman/generators
Downloads the entire project code from GitHub to your computer.
cd generators
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Node.js Node.js must be installed to use npm.
npm i -g sugar-generate
Installs the package published on the npm registry globally β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f api/server/dockerFile.js -t generators .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 generators
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Node.js
EasyPrerequisites
npm i -g sugar-generate
Installs the package published on the npm registry globally β no need to clone the source.
npm i
Type this command into your terminal and run it.
npm run start
Starts the development/run server.
npm run dev
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)