34 lines
No EOL
1.5 KiB
Markdown
34 lines
No EOL
1.5 KiB
Markdown
<div align="center">
|
|
<a href="https://postwoman.io"><img src="https://postwoman.io/icons/logo.svg" alt="Postwoman" height="128"></a>
|
|
<br>
|
|
<h1>Postwoman Proxy</h1>
|
|
<p>
|
|
API request builder - Helps you create your requests faster, saving you precious time on your development.
|
|
</p>
|
|
</div>
|
|
|
|
---
|
|
|
|
A simple proxy server created for [Postwoman](https://github.com/liyasthomas/postwoman/) and hosted by [ApolloTV](https://apollotv.xyz/).
|
|
|
|
## Demo 🚀
|
|
[https://postwoman.io](https://postwoman.io)
|
|
|
|
## Usage 💡
|
|
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
|
2. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman-proxy`).
|
|
3. Compile the TypeScript code with `npm run build`.
|
|
4. Start the production server with `npm start`.
|
|
|
|
#### Or with [pm2](https://pm2.io/):
|
|
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
|
2. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman-proxy`).
|
|
3. Compile the TypeScript code with `npm run build`.
|
|
4. Start the pm2 process with `pm2 start`.
|
|
|
|
## Developing 👷
|
|
|
|
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git.
|
|
2. Install dependencies by running `npm install` within the directory that you cloned (probably `postwoman-proxy`).
|
|
3. Start the development server with `npm run dev`.
|
|
4. Set the proxy URL in Postwoman to the URL that is logged when you run the proxy. |