Skip to content

Commit

Permalink
fix: change coordinator base url, update old links
Browse files Browse the repository at this point in the history
  • Loading branch information
bucko13 committed Feb 13, 2024
1 parent af65053 commit 1a5b408
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 22 deletions.
5 changes: 5 additions & 0 deletions .changeset/thirty-camels-think.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@caravan/coordinator": patch
---

Change the baseUrl for caravan coordinator from /caravan/# to /coordinator/#
24 changes: 9 additions & 15 deletions apps/coordinator/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# Caravan - Stateless Multisig Coordinator

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![Build Status](https://travis-ci.com/unchained-capital/caravan.svg?branch=master)](https://travis-ci.com/unchained-capital/caravan)
[![dependencies Status](https://david-dm.org/unchained-capital/caravan/status.svg)](https://david-dm.org/unchained-capital/caravan)
[![devDependencies Status](https://david-dm.org/unchained-capital/caravan/dev-status.svg)](https://david-dm.org/unchained-capital/caravan?type=dev)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

Caravan is making bitcoin multisig custody easier and safer through
transparency and standards.

Expand All @@ -16,7 +10,7 @@ addresses.
Caravan is also stateless. It does not itself store any data. You must
safekeep the addresses (and redeem scripts & BIP32 paths) you create.

[Try Caravan now!](https://unchained-capital.github.io/caravan)
[Try Caravan now!](https://caravan-bitcoin.github.io/coordinator)

## Installation

Expand All @@ -26,15 +20,15 @@ be run in any web browser from a local or remote installation.
### Unchained Capital GitHub

The simplest way to use Caravan is to visit
[https://unchained-capital.github.io/caravan](https://unchained-capital.github.io/caravan),
[https://caravan-bitcoin.github.io/coordinator](https://caravan-bitcoin.github.io/coordinator),
a copy of Caravan hosted on GitHub by
[Unchained Capital](https://www.unchained.com).

### Your Own GitHub

If you would prefer to host your own copy of Caravan on GitHub, you
can do so by first forking the
[Caravan repository](https://github.com/unchained-capital/caravan)
[Caravan repository](https://github.com/caravan-bitcoin/caravan)
into your own GitHub organization. Go to the (newly forked) repository's "Settings" page and
scroll down to the "GitHub Pages" section. Make sure to setup the settings
to us a gh-pages branch (create the branch if necessary).
Expand All @@ -49,7 +43,7 @@ $ turbo run deploy
```

You should see a copy of the Caravan web application at
`https://YOUR_GITHUB_USERNAME.github.io/caravan`. If not, go back to the
`https://YOUR_GITHUB_USERNAME.github.io/coordinator`. If not, go back to the
GitHub Pages section and ensure you see a message
saying "Your site is published at ...".

Expand All @@ -59,7 +53,7 @@ You can always clone the source code of Caravan to your local machine
and run it from there. You will require a recent `npm` installation.

```bash
$ git clone https://github.com/unchained-capital/caravan
$ git clone https://github.com/caravan-bitcoin/caravan
...
$ cd caravan
$ npm install
Expand All @@ -68,7 +62,7 @@ $ npm run dev
...
```

Now visit http://localhost:5173 to interact with your local copy of
Now visit http://localhost:5173/coordinator/# to interact with your local copy of
Caravan.

### Host Remotely
Expand Down Expand Up @@ -110,8 +104,8 @@ Caravan should then be accessible at http://localhost:8000/caravan/#

## Usage

If you can access the [Caravan web
application](https://unchained-capital.github.io/caravan) in your
If you can access the [Caravan Coordinator web
application](https://caravan-bitcoin.github.io/coordinator) in your
browser, you are ready to start using Caravan.

Click the _Create_ or _Interact_ links in the navbar to get started.
Expand Down Expand Up @@ -359,4 +353,4 @@ point that if corsproxy is running, paste your node's IP:port on the end of the

## Contributing

Please see the [`CONTRIBUTING.md`](./CONTRIBUTING.md) and the open [GitHub Issues](https://github.com/unchained-capital/caravan/issues)
Please see the [`CONTRIBUTING.md`](./CONTRIBUTING.md) and the open [GitHub Issues](https://github.com/caravan-bitcoin/caravan/issues)
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const PrivateClientSettings = ({
"Due to CORS requirements, you must use a proxy around the node. Instructions are available "
}
{externalLink(
"https://github.com/unchained-capital/caravan#adding-cors-headers",
"https://github.com/caravan-bitcoin/caravan#adding-cors-headers",
"here",
)}
{"."}
Expand Down
2 changes: 1 addition & 1 deletion apps/coordinator/src/components/ErrorBoundary.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React, { ErrorInfo } from "react";

import { Box, Typography } from "@mui/material";

const reportingURL = "https://github.com/unchained-capital/caravan/issues";
const reportingURL = "https://github.com/caravan-bitcoin/caravan/issues";

interface ErrorBoundaryProps {
children: React.ReactNode;
Expand Down
2 changes: 1 addition & 1 deletion apps/coordinator/src/components/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const Footer = () => (
<Grid container justifyContent="space-between" alignItems="center">
<Grid item sm={2}>
{externalLink(
"https://www.unchained-capital.com",
"https://www.unchained.com",
<img
src={logo}
className="logo"
Expand Down
6 changes: 3 additions & 3 deletions apps/coordinator/src/components/Help.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ const Help = () => (
</ListItemIcon>
<ListItemText>
{externalLink(
"https://unchained-capital.com/blog/gearing-up-the-caravan/",
"https://unchained.com/blog/gearing-up-the-caravan/",
"Blog Post",
)}
</ListItemText>
Expand All @@ -198,7 +198,7 @@ const Help = () => (
</ListItemIcon>
<ListItemText>
{externalLink(
"https://github.com/unchained-capital/caravan",
"https://github.com/caravan-bitcoin/caravan",
"Source Code",
)}
</ListItemText>
Expand Down Expand Up @@ -261,7 +261,7 @@ const Help = () => (
Seeing a bug or need a feature?
</CardContent>
<CardActions>
<Button href="https://github.com/unchained-capital/caravan/issues">
<Button href="https://github.com/caravan-bitcoin/caravan/issues">
<BugReport /> &nbsp; Report Issue
</Button>
<Button data-cy="run-tests-button" component={Link} to="/test">
Expand Down
2 changes: 1 addition & 1 deletion apps/coordinator/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import path from "path";

// https://vitejs.dev/config/
export default defineConfig({
base: "/caravan/#",
base: "/coordinator/#",
resolve: {
alias: {
utils: path.resolve(__dirname, "./src/utils"),
Expand Down

0 comments on commit 1a5b408

Please sign in to comment.