🚧 Get Structure

🌀 Get Structure is an API that helps to get hierarchy (structure) of an github repository like tree command in bash

⚡Quick API Docs

Example Request:

POST 
getstructure.noir.land

{
 body: {
	 username: "Noirrs",
	 repository: "getStructure",
	 branch: "master"
	}
}

* API endpoint: getstructure.noir.land

* username: Repository Author's github nickname
* repository: Github Repository's name
* branch: Github Repository's main branch [generally => master / main] 

* method: POST

Example Response:

* Response Type: String | Error<typless>

├─ src
│  ├─ main.ts
│  ├─ app.service.ts
│  ├─ app.module.ts
│  ├─ app.controller.ts
│  ├─ functions
│  │  ├─ separateRoots.ts
│  │  ├─ separatePaths.ts
│  │  ├─ separateFiles.ts
│  │  ├─ mergeSeparateds.ts
│  │  ├─ makeTree.ts
│  │  ├─ main.ts
│  │  ├─ getRepository.ts
│  │  └─ getFileNames.ts
│  └─ types
│     └─ types.d.ts
├─ .gitignore
├─ README.md
├─ nest-cli.json
├─ package-lock.json
├─ package.json
├─ tsconfig.build.json
├─ tsconfig.json
└─ vercel.json

✍️ Source Code

Resources

• Treeify

• NestJS

• Axios

• Vercel

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Deploy on Vercel

📱 Contact