Remotify

Gather with fun
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project ❓
   • Built With 🏗️
2. Usage 🎮
   • Make yourself at home 🏠
   • Invite your friends 👩‍👩‍👦‍👦
3. Contributing 👩‍💻
   • Frontend only 📱
   • Run whole remotify on your system 👑
4. License
5. Contact
6. Acknowledgments

About The Project

❓

Remotify is here to create an enjoyable work atmosphere and culture in a virtual place. Remotify is all about openness, self determination and fun.
You can meet and work, express your feelings, change the room to your needs and even adapt the code to your needs and host it for youselves.

(back to top)

Built With

🏗️

• React.js
• Phaser.js
• Hasura GraphQL
• Next.js
• Ant Design

(back to top)

Usage

🎮

Go to https://meet.remotify.place
Once the app is loaded you can do different things

Make yourself at home

🏠

On the left top side there is a 🍔 menu.
Click on it and you reveal the only option currently available.
Click on Edit mode, close the menu and you will see edit toolbar.
There you can modify the place to your needs.

Invite your friends

👩‍👩‍👦‍👦

There is an invite button on the top of the screen.
When you click on it an url is copied to your clipboard automatically.
This link can be shared with the people you want to invite and have fun with.

(back to top)

Contributing

👩‍💻

First of all I really appreciate every contribution of you. Thanks in advance 🤝 🤗
I'm actively looking for contributers.
Especially for design biased frontend people who would like to reinvent the look and feel of remotify.
Somehow everything I touch ends up looking nerdy 🤷‍♂️

There are two ways depending on whether you want to work in the backend or frontend.

Frontend only

📱

• filter or keep an I out for issues with the label
• checkout the project using git clone https://github.com/flodev/remotify.git
• checkout a feature branch
• run npm install or yarn install
• run npm run storybook or yarn storybook

Run whole remotify on your system

👑

This step isn't particularely difficult either. You just have to install a few more things.
I've tried my best to do a local setup for you as easy as possible.

• install docker (https://www.docker.com/get-started)
• install minikube (https://minikube.sigs.k8s.io/docs/start/)
• install kubctl (https://kubernetes.io/docs/tasks/tools/)
• install helm chart (https://helm.sh/docs/intro/install/)
• install tilt (https://docs.tilt.dev)

create minikube profile

• execute minikube start -p tilt-remotify

now run the system

• checkout the project using git clone https://github.com/flodev/remotify.git
• checkout a feature branch
• navigate to the root folder of remotify (where Tiltfile is located)
• then run tilt up

Now tilt watches over your file change activities and will reload to kubernetes pod as soon as you update a file.

NOTE: It will probably take a few beats to get the system up and running.
You can open the browser to see the progress.
The frontend currently takes a bit too long to get up and running. Once it's up you can reach it using the browser http://localhost:3001. It should look this way in your terminal:

After consideration I suggest that you run the frontend from your local system and use all the other systems from tilt.
The frontend build just takes to long to work with that productivly. I've set the trigger mode in tilt to manual so you need to click on to update the frontend.

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/flodev/remotify

(back to top)