Companion App

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

Warning

The code in this project was generated using Co-Pilot. This is never meant to hit production and is very much a joke I mnade with a friend.

🎯 About

This app is a lighthearted satire inspired by a friend's insistence that they needed to vet anyone I showed interest in. It playfully explores the idea of having a 'companion app' to help screen potential connections, poking fun at the modern dating experience and the lengths friends will go to protect each other. Not to be taken seriously—unless you really want your friends involved!

✨ Features

✔️ Custom questionnaires for vetting potential connections;
✔️ Results dashboard for friend reviews;
✔️ Secure login and user management;

🚀 Technologies

The following tools and technologies were used in this project:

• Node.js
• React
• React Native
• Vite
• Bun
• Docker
• JavaScript
• CSS
• HTML

✅ Requirements

Before starting 🏁, you need to have Git and Node installed as well as Bun.

Edit your .env file:

GOTIFY_URL=https://gotify.yourdomain.com
GOTIFY_TOKEN=your_gotify_token
USERS_ENV=[{"username":"admin","password":"changeme"}]
TIMEZONE=America/Detroit

🏁 Starting

# Clone this project
$ git clone https://github.com/JershBytes/companion-app

# Access
$ cd companion-app

# Install dependencies
$ ./install-all.sh

# Run the project
$ bun run start

# The server will initialize in the <http://localhost:5173>

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Joshua Ross

 

Back to top