Skip to content

Latest commit

 

History

History
110 lines (66 loc) · 2.71 KB

README.md

File metadata and controls

110 lines (66 loc) · 2.71 KB

WorkAround App

Netlify Status Tests MPL-2.0 License WorkAroundHQ

The WorkAround application is a platform for digital nomads who call the world their home. With WorkAround, digital nomads can pick their next ideal destination and connect with the community there.

Run Locally

  1. Clone repository:
git clone git@github.com:WorkAroundHQ/app.git
  1. Change directory:
cd app
  1. Install packages:
yarn

  1. Add values to .env file (see sample.env)

  2. Start development server:

yarn start

Automated Testing

Run automated tests:

These tests also get executed with GitHub Actions on PRs onto main!

yarn test

Run cypress tests:

  1. Add values to cypress.env.json (see sample.cypress.env.json)

  2. Start development server:

yarn start
  1. Start cypress:
yarn cy
  1. Start test in Cypress app.

Deployment

The deployment process is simple:

  • Every push on main triggers a build on Netlify
  • Every open pull request with target main, creates a deploy preview on Netlify

Architecture

WorkAround-Architecture

Frontend

WorkAround is a Single Page Application developed with ReactJs and SCSS as a CSS preprocessor.

Hosting

WorkAround ist hosted on Netlify's CDN to provide fast loading times for users around the globe.

Backend

Supabase provides three different services:

  • Database
  • Authentication / Authorization
  • Storage

These services can be accessed via different REST endpoints, dynamically created by Supabase.

Security Measures

Have a look on our Security Measures.

Feedback

If you have any feedback, please reach out to us @WorkAroundHQ

Authors

@mrcgrhrdt

License

Mozilla Public License Version 2.0

Made with ❤️ and ☕️