https://github.com/solidcouch/solidcouch
Decentralized hospitality exchange software built with Solid Protocol. Soon, you can also start a community!
https://github.com/solidcouch/solidcouch
decentralized hospex hospitality-exchange solid-protocol
Last synced: 3 months ago
JSON representation
Decentralized hospitality exchange software built with Solid Protocol. Soon, you can also start a community!
- Host: GitHub
- URL: https://github.com/solidcouch/solidcouch
- Owner: solidcouch
- License: other
- Created: 2023-01-31T17:37:35.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T14:59:10.000Z (over 1 year ago)
- Last Synced: 2024-10-24T17:53:00.051Z (about 1 year ago)
- Topics: decentralized, hospex, hospitality-exchange, solid-protocol
- Language: TypeScript
- Homepage: https://solidcouch.org
- Size: 25.6 MB
- Stars: 25
- Watchers: 3
- Forks: 7
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SolidCouch
A decentralized hospitality exchange community app built with Solid Protocol.
Please read the [SolidCouch Announcement](https://mrkvon.org/blog/announcing-solidcouch).
## Developer quick start
This is a single page application written in React.
You need node v20. You can use [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to switch to that particular version. You also need [yarn](https://classic.yarnpkg.com/en/docs/install).
1. Clone this repository on your computer
```bash
git clone https://github.com/solidcouch/solidcouch.git
```
1. Go to the project directory
```bash
cd solidcouch
```
1. Install dependencies
```bash
yarn
```
1. Run the app
```bash
yarn dev
```
You can also [configure the app](./docs/Configuration.md) with environment variables, e.g.:
```bash
VITE_COMMUNITY="https://community.example/community#us" VITE_COMMUNITY_CONTAINER="community-example" yarn dev`
```
## Testing
We use [Cypress](https://www.cypress.io/app) to test the application.
To start the tests, run `yarn cy:dev`, wait a bit, and Cypress will open. Select "E2E tests" from the options, then pick your preferred browser (Electron and Chromium work, Firefox fails), and select a test suite to run.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) and [NOTICE](NOTICE) files for details.
**Note:** The logos, trademarks, and designs included in this repository are not covered by the MIT License.
They are the property of their respective owners and may not be used without permission.