Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.44 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.44 KB
Raw

Sleepy.bike

a decentralized hospitality exchange community for slow travellers

We're developing based on wireframes and design (WIP - do you want to help? Join our bi-weekly OpenHospitalityNetwork calls and tell us)

Developer quick start

This is a single page application written in React.

You need Node v16. You can use nvm to switch to that particular version. You also need yarn.

  1. Clone this repository on your computer

    git clone https://github.com/OpenHospitalityNetwork/sleepy.bike.git

  2. Go to the project directory

    cd sleepy.bike

  3. Install dependencies

    yarn

  4. Run the app

    yarn start

You can also configure the app with environment variables, e.g.:

REACT_APP_COMMUNITY="https://community.example/community#us" REACT_APP_COMMUNITY_CONTAINER="community-example" yarn start`

Testing

We use Cypress 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.