https://github.com/anas727189/buddyboard
BuddyBoard is a comprehensive friend management platform designed to help you maintain your personal relationships in our increasingly digital world. This modern web application serves as your CRM (Contact Relationship Management) system, helping you keep track of important details about your friends and maintain meaningful connections.
https://github.com/anas727189/buddyboard
chakra-ui flask gunicorn gunicorn-with-flask-rest-api python reactjs sqlalchemy taiwlindcss typescript wsgi
Last synced: 2 months ago
JSON representation
BuddyBoard is a comprehensive friend management platform designed to help you maintain your personal relationships in our increasingly digital world. This modern web application serves as your CRM (Contact Relationship Management) system, helping you keep track of important details about your friends and maintain meaningful connections.
- Host: GitHub
- URL: https://github.com/anas727189/buddyboard
- Owner: ANAS727189
- Created: 2024-09-07T10:08:23.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T10:13:23.000Z (over 1 year ago)
- Last Synced: 2025-02-05T18:38:08.217Z (over 1 year ago)
- Topics: chakra-ui, flask, gunicorn, gunicorn-with-flask-rest-api, python, reactjs, sqlalchemy, taiwlindcss, typescript, wsgi
- Language: TypeScript
- Homepage: https://buddyboard.onrender.com/
- Size: 102 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🤝 BuddyBoard
BuddyBoard is a modern, user-friendly web application for managing and tracking your friends. With its sleek UI and intuitive UX, BuddyBoard makes it easy to keep in touch with your social circle.
## 🌟 Features
- ✨ **Sleek UI/UX**: Built with React and Chakra UI for a modern, responsive design
- 📊 **Dashboard**: View all your friends at a glance
- ➕ **Add Friends**: Easily add new friends to your board
- 🖊️ **Edit Details**: Update friend information with just a few clicks
- 🗑️ **Remove Friends**: Streamlined process for removing entries
- 🌓 **Light/Dark Mode**: Toggle between light and dark themes for comfortable viewing
- 📱 **Responsive Design**: Looks great on desktop, tablet, and mobile devices
## 🛠️ Tech Stack
- **Frontend**: React, Chakra UI, React Router
- **Backend**: Python, Flask, SQLAlchemy
- **Database**: SQLite
- **Deployment**: Render
## 🚀 Getting Started
### Prerequisites
- Node.js (v14 or later)
- Python (v3.7 or later)
- pip
### Installation
1. Clone the repository:
```bash
git clone https://github.com/ANAS727189/BuddyBoard.git
cd BuddyBoard
```
2. Set up the backend:
```bash
cd backend
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
pip install -r requirements.txt
```
3. Set up the frontend:
```bash
cd ../client
npm install
```
4. Start the development servers:
Backend:
```bash
cd backend
flask run
```
Frontend:
```bash
cd client
npm start
```
5. Open your browser and navigate to `http://localhost:3000` to view the app.
## 🌐 Live Demo
Visit the live application at: [https://buddyboard.onrender.com/](https://buddyboard.onrender.com/)
## 📖 Documentation
For more detailed information about the app's features, API endpoints, and deployment process, please refer to our [Documentation](./docs/README.md).
## 🤝 Contributing
We welcome contributions to BuddyBoard! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 👏 Acknowledgements
- [React](https://reactjs.org/)
- [Chakra UI](https://chakra-ui.com/)
- [Flask](https://flask.palletsprojects.com/)
- [SQLAlchemy](https://www.sqlalchemy.org/)
## 📞 Contact
For any questions or feedback, please reach out to us at [support@buddyboard.com](mailto:support@buddyboard.com).
Happy friend tracking! 🎉