btwedutech/hoppscotch
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

refactor: update build docs

Browse Source
This commit is contained in:
liyasthomas
2021-09-17 13:57:56 +05:30
parent e90b26ebed
commit 46a0f6e3f8
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -173,7 +173,7 @@ _Collections are synced with cloud / local session storage_
- Hide your IP address - Hide your IP address
- Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues - Fixes [`CORS`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Resource Sharing) issues
- Access APIs served in non-HTTPS `[http://]` endpoints - Access APIs served in non-HTTPS (`http://`) endpoints
- Use your own Proxy URL - Use your own Proxy URL
_Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/hoppscotch/proxyscotch)** - **[Privacy Policy](https://docs.hoppscotch.io/privacy)**_ _Official proxy server is hosted by Hoppscotch - **[GitHub](https://github.com/hoppscotch/proxyscotch)** - **[Privacy Policy](https://docs.hoppscotch.io/privacy)**_
@@ -290,7 +290,7 @@ _Add-ons are developed and maintained under **[Hoppscotch Organization](https://
## **Developing** ## **Developing**
0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/.env.example) file found in repository's root directory with your own keys and rename it to `.env`. 0. Update [`.env.example`](https://github.com/hoppscotch/hoppscotch/blob/main/.env.example) file found in `packages/hoppscotch-app` with your own keys and rename it to `.env`.
_Sample keys only works with the [production build](https://hoppscotch.io)._ _Sample keys only works with the [production build](https://hoppscotch.io)._
@@ -302,8 +302,8 @@ _Sample keys only works with the [production build](https://hoppscotch.io)._
### Local development environment ### Local development environment
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. 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 `hoppscotch`). 2. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`).
3. Start the development server with `npm run dev`. 3. Start the development server with `pnpm run dev`.
4. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser. 4. Open development site by going to [`http://localhost:3000`](http://localhost:3000) in your browser.
### Docker compose ### Docker compose
@@ -323,9 +323,9 @@ docker run --rm --name hoppscotch -p 3000:3000 hoppscotch/hoppscotch:latest
## **Releasing** ## **Releasing**
1. [Clone this repo](https://help.github.com/en/articles/cloning-a-repository) with git. 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 `hoppscotch`). 2. Install dependencies by running `pnpm install` within the directory that you cloned (probably `hoppscotch`).
3. Build the release files with `npm run generate`. 3. Build the release files with `pnpm run generate`.
4. Find the built project in `./dist`. 4. Find the built project in `packages/hoppscotch-app/dist`.
## **Contributing** ## **Contributing**

6
netlify.toml
View File

@@ -1,7 +1,7 @@
[build] [build]
base = "packages/hoppscotch-app/" base = "/"
publish = "dist" publish = "packages/hoppscotch-app/dist"
command = "npm run generate" command = "pnpm run generate"
environment = { NODE_VERSION = "14" } environment = { NODE_VERSION = "14" }
[[redirects]] [[redirects]]