Topology-API
Topology-API is an API that provides the functionality to access, manage and store device topologies. The best candidate for such an application is c++, but since I wanted to deliver it as fast as possible, I thought about javascript, but once again JS can't deal well with OOP applications. so I went with a similar yet better OOP language: typescript. Also has easy testing & documentation.
- main project typescript
- Unit testing: jest.
- Function documentation: typedoc.
This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructions.
- Clone the repository
git clone git@github.com:GeekMind00/Topology-API.git- Navigate to repository directory
$ cd Topology-API- Install dependencies
$ npm i- Running the application
$ npm run start- Console Commands:
- To read a topology from a json file and store it in memory:
read [filename] - To write a topology from memory to a json file:
write [topologyID] - To delete a certain topology from memory:
delete [topologyID] - To query all the topologies in memory:
getTopologies - To query all devices of a certain topology:
getDevices [topologyID] - To query all devices of a certain topology that has a certain netlist node:
getDevicesWithNetlistNode [topologyID] [netlistNodeID]
- To read a topology from a json file and store it in memory:
- Running the tests
$ npm run test- Running the documentation
$ npm run docdoc -> index.html
coverage -> index.html