Skip to content

adamkasztenny/hybridly

Repository files navigation

Hybridly

WorkflowCoverage Status

An open source hybrid work solution 🏢

⭐ Features ⭐

  • Set a limit on the total number of people in the office per day
  • Employees can reserve time in the office
  • Employees can book desks and meeting rooms
  • View when others are in the office and where they are working
  • View charts and metrics to see how employees are using the office
  • Single-sign on (via Auth0)

See the backlog for planned features.

Quick Start

You will need an Auth0 account, as well as Docker, make and Ruby 3.0.0 installed for these steps.

  1. In Auth0, create a regular web application.

  2. Allowed Callback URLs should be http://localhost:3000/authentication/callback

  3. Allowed Web Origins and Allowed Origins (CORS) should be http://localhost:3000

  4. Run these steps to start the server:

	export DEFAULT_USER_EMAIL=<the email you plan to log in with>

	# these values will be in the Auth0 application
	export AUTH0_DOMAIN=...
	export AUTH0_CLIENT_ID=...
	export AUTH0_CLIENT_SECRET=...

	make create_secret
	make start
	make seed_container

Open localhost:3000 in your browser to use Hybridly!

Local Development

In addition to the tools above, you will also need Node and Yarn installed for local development. asdf can be used to manage tool versions.

To start the development server, the steps are the same as above, except run make start_development instead of make start, and run make seed instead of make seed_container.

To run tests, run make test. To run the linter, run make lint.