Skip to content

Project setup and architechure explored #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Project setup and architechure explored #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions day19_architecture_summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Day 19 – App Architecture & Endpoint Summary

## ✅ Local Setup
- Cloned from: https://github.com/Jasonwill2004/fullstack-webApp-For-TestAndSecurity.git
- All dependencies installed at root level (unified structure)
- Launched using `npm run start-dev` which runs:
- Frontend (webpack-dev-server)
- Backend (nodemon with babel-node)

## 🏗️ Architecture

### Frontend: `/src/app`
- Built using **React.js + Redux**
- Key Components:
- `Dashboard.jsx`: Main application view
- `Login.jsx` & `Signup.jsx`: Authentication flows
- `TaskDetail.jsx` & `TaskList.jsx`: Task management
- `Navigation.jsx`: App navigation
- Uses Redux store (`/src/app/store`)
- `sagas.js`: Handles async operations
- `mutations.js`: State updates
- `reducer.js`: State management

### Backend: `/src/server`
- Built using **Express.js**
- MongoDB for database
- Key Files:
- `server.js`: Main Express application
- `authenticate.js`: Authentication logic
- `communicate-db.js`: Database operations
- `connect-db.js`: MongoDB connection
- `initialize-db.js`: Database setup

### Environment
- MongoDB URI: `mongodb://localhost:27017/organizer`
- Frontend Port: 8080
- Backend Port: 7777

## 🌐 Endpoints Overview

| Method | Endpoint | Description |
|--------|-------------------|--------------------------------|
| POST | `/authenticate` | User login |
| POST | `/user/create` | Create new user account |
| GET | `/tasks` | Retrieve all tasks |
| POST | `/task/new` | Create a new task |
| POST | `/task/update` | Update existing task |

## 🔁 UI Flow Observed
1. **Authentication Flow**
- User starts at login page
- Can switch to signup for new account
- Redirects to dashboard after authentication

2. **Task Management Flow**
- Dashboard displays task list
- Can create new tasks
- Can view task details
- Can update task status
- Can navigate between different views

## 💾 Data Structure
```javascript
Task {
id: string,
name: string,
isComplete: boolean
}

User {
id: string,
username: string,
passwordHash: string
}
```

## 🔧 Technical Stack
- **Frontend**: React, Redux, Redux-Saga
- **Backend**: Express, MongoDB
- **Build Tools**: Webpack, Babel
- **Development**: Nodemon, Concurrently
Loading