https://github.com/solobarine/org-tree
An Organizational Relationship Tree
https://github.com/solobarine/org-tree
Last synced: 10 days ago
JSON representation
An Organizational Relationship Tree
- Host: GitHub
- URL: https://github.com/solobarine/org-tree
- Owner: Solobarine
- Created: 2025-02-20T13:31:54.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-20T13:41:54.000Z (over 1 year ago)
- Last Synced: 2025-02-20T14:34:49.754Z (over 1 year ago)
- Language: Python
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ORG-TREE
Org Tree is a tree chart showing relationships between employees.
## SETUP
- 1. Clone the repo
```
git clone https://github.com/solobarine/org-tree
cd org-tree
```
- 2. Create virtual environment
```
python -m venv .venv
```
- 3. Activate virtual environment
```
source .venv/bin/activate
```
### BACKEND
- 1. Navigate to backend directory
```
cd backend
```
- 2. Install Backend Dependencies
```
pip install -r requirements.txt
```
- 3. Start FastAPI Server
```
fastapi dev main.py
```
- 4. Seed Database
Navigate to http://localhost:8000/seed-database to seed db with employees
### CLIENT
- 1. Navigate to client directory
```
cd client
```
- 2. Install dependencies
```
npm install
```
- 3. Start dev server
```
npm run dev
```
- 4. View client on http://localhost:5173
## DESIGN CHOICES
The database used was SQLite because of simplicity and ease of setup.
## TIME LOG
2hrs 34 mins (Outside planning).
## TODOS
- Implement the drag and drop functionality.
- Connect the client with the backend to make the request to update manager.
- Polish the Tree UI, making it look more like a tree.
- Implement UI feedback on successfully or failed API requests and creation of loading indicator when API request is pending.
## AI Collaboration
I used ChatGPT in improving the code quality of the backend API and in generating the data used in the frontend.