README.md

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

This project provides endpoints for the API specification format conversions supported by Lucy's and other converters via a single API. The endpoints are also be exposed to end-users using a React web app.

Built With

• Node.js
• Express.js
• React.js

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/postmanlabs/api-spec-converter.git

2. Install NPM packages

   npm install

Get the server and react-app running

Server

1. cd into server and run node index.js to start the server on port 3001. The port can be changed in index.js.

React-app

2. cd into react-app and run npm start to start the react app on port 3000. You'll be able to view the app in a browser at localhost:3000.