https://github.com/postmanlabs/api-spec-converter
https://github.com/postmanlabs/api-spec-converter
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/postmanlabs/api-spec-converter
- Owner: postmanlabs
- Created: 2021-06-07T12:12:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-13T10:40:56.000Z (over 4 years ago)
- Last Synced: 2025-01-30T07:11:35.775Z (12 months ago)
- Language: JavaScript
- Size: 778 KB
- Stars: 10
- Watchers: 7
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## 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
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/postmanlabs/api-spec-converter.git
```
2. Install NPM packages
```sh
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`.