Skip to content

zeyad-yasser/friends-manager-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Friends Management Application

A full-stack web application built with Flask and React for managing friends' information.

Project Structure

Flask_React/
├── Flask_Server/         # Backend Flask application
│   ├── app.py           # Main Flask application
│   ├── models.py        # Database models
│   ├── routes.py        # API routes
│   └── requirements.txt # Python dependencies
│
├── client/              # Frontend React application
│   ├── public/         
│   ├── src/            
│   │   ├── components/ # React components
│   │   ├── services/   # API services
│   │   └── App.js      # Main React component
│   ├── package.json    
│   └── README.md       
│
└── README.md           # This file

Features

  • RESTful API with Flask backend
  • React frontend with Material-UI components
  • SQLite database with SQLAlchemy ORM
  • CRUD operations for friend management
  • Automatic avatar generation based on gender
  • Responsive design for all screen sizes

Getting Started

Backend Setup

  1. Navigate to Flask_Server directory:
cd Flask_Server
  1. Create and activate virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Run Flask application:
python app.py

The backend server will start at http://localhost:5000

Frontend Setup

  1. Navigate to client directory:
cd client
  1. Install dependencies:
npm install
  1. Start development server:
npm start

The frontend application will start at http://localhost:3000

API Endpoints

  • GET /api/friends - Get all friends
  • POST /api/friends - Create a new friend
  • PATCH /api/friends/<id> - Update a friend
  • DELETE /api/friends/<id> - Delete a friend

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published