https://github.com/maina-m19/user_search_app
Full-stack user search app using React (frontend) and Flask (backend) that supports free text search by first name, last name, and SSN. Built as a coding assignment.
https://github.com/maina-m19/user_search_app
flask python3 react
Last synced: 3 months ago
JSON representation
Full-stack user search app using React (frontend) and Flask (backend) that supports free text search by first name, last name, and SSN. Built as a coding assignment.
- Host: GitHub
- URL: https://github.com/maina-m19/user_search_app
- Owner: Maina-M19
- Created: 2025-04-09T17:21:44.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-09T18:37:17.000Z (about 1 year ago)
- Last Synced: 2025-04-09T19:31:13.007Z (about 1 year ago)
- Topics: flask, python3, react
- Language: JavaScript
- Homepage:
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# User Search App
A full-stack web application that allows users to perform free-text searches by first name, last name, or SSN. Built as a coding assignment, this project utilizes React for the frontend and Flask for the backend.
---
## Features
- **Search Functionality**: Perform free-text searches by first name, last name, or SSN.
- **Responsive Design**: Ensures usability across various devices and screen sizes.
- **RESTful API**: Backend API built with Flask to handle search queries.
---
## Technologies Used
- **Frontend**:
- React
- JavaScript
- HTML/CSS
- **Backend**:
- Flask
- Python 3
- SQLite
---
## Project Structure
```
User_Search_App/
├── backend/
│ ├── app.py
│ └── ... (other backend files)
├── frontend_react/
│ ├── public/
│ └── src/
│ ├── components/
│ ├── App.js
│ └── index.js
├── README.md
└── requirements.txt
```
---
## Setup Instructions
### Prerequisites
- Node.js and npm installed
- Python 3 installed
- Git installed
### Backend Setup
1. Navigate to the backend directory:
```bash
cd backend
```
2. Create a virtual environment:
```bash
python -m venv venv
```
3. Activate the virtual environment:
- On macOS/Linux:
```bash
source venv/bin/activate
```
- On Windows:
```bash
venv\Scripts\activate
```
4. Install the required packages:
```bash
pip install -r requirements.txt
```
5. Run the Flask application:
```bash
python app.py
```
The backend server will start on `http://localhost:5000`.
### Frontend Setup
1. Navigate to the frontend directory:
```bash
cd frontend_react
```
2. Install the required packages:
```bash
npm install
```
3. Start the React application:
```bash
npm start
```
The frontend will be accessible at `http://localhost:3000`.
---
## Usage
1. **Access the application**:
Open your browser and navigate to `http://localhost:3000`.
2. **Perform a search**:
- Enter a first name, last name, or SSN into the search bar.
- Click the "Search" button to view matching results.
---
## API Endpoints
- `GET /api/search?query=`: Retrieve users matching the search term.
---
## Contributing
Contributions are welcome! Please follow these steps:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/YourFeature
```
3. Commit your changes:
```bash
git commit -m 'Add some feature'
```
4. Push to the branch:
```bash
git push origin feature/YourFeature
```
5. Open a pull request.
---
## License
This project is licensed under the MIT License. See the LICENSE file for details.