{"id":22956756,"url":"https://github.com/deividas-butkus/final-project-evaluation-ca","last_synced_at":"2026-04-11T05:04:18.675Z","repository":{"id":265116850,"uuid":"877889032","full_name":"deividas-butkus/final-project-evaluation-ca","owner":"deividas-butkus","description":"A feature-rich web application enabling user registration, login, profile updates, messaging, and conversation management. Built with React (with TypeScript), Node.js, and MongoDB, it features JWT authentication, real-time messaging with Socket.IO, and follows best practices like trunk-based development and Git workflows.","archived":false,"fork":false,"pushed_at":"2024-11-30T12:56:27.000Z","size":7872,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-14T17:11:06.142Z","etag":null,"topics":["atomic-design","backend-development","express","front-end-development","fullstack-development","git","github","graceful-shutdown","jwt-authentication","material-ui","mongodb","node-js","react","real-time-messaging","router","socket-io","styled-components","typescript","vite"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deividas-butkus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-24T12:21:57.000Z","updated_at":"2024-11-30T12:56:29.000Z","dependencies_parsed_at":"2024-11-27T19:35:02.086Z","dependency_job_id":null,"html_url":"https://github.com/deividas-butkus/final-project-evaluation-ca","commit_stats":null,"previous_names":["deividas-butkus/final-project-evaluation-ca"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deividas-butkus%2Ffinal-project-evaluation-ca","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deividas-butkus%2Ffinal-project-evaluation-ca/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deividas-butkus%2Ffinal-project-evaluation-ca/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deividas-butkus%2Ffinal-project-evaluation-ca/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deividas-butkus","download_url":"https://codeload.github.com/deividas-butkus/final-project-evaluation-ca/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237679337,"owners_count":19349159,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atomic-design","backend-development","express","front-end-development","fullstack-development","git","github","graceful-shutdown","jwt-authentication","material-ui","mongodb","node-js","react","real-time-messaging","router","socket-io","styled-components","typescript","vite"],"created_at":"2024-12-14T17:11:26.882Z","updated_at":"2025-12-30T18:54:48.787Z","avatar_url":"https://github.com/deividas-butkus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chat Management System\n\nThis project is a full-stack chat management system built with a React frontend and an Express backend, along with MongoDB for data storage.\n\n---\n\n## Table of Contents\n\n- [Chat Management System](#chat-management-system)\n  - [Table of Contents](#table-of-contents)\n  - [Prerequisites](#prerequisites)\n  - [Cloning the Project](#cloning-the-project)\n  - [Frontend (Client) Setup](#frontend-client-setup)\n  - [Backend (Server) Setup](#backend-server-setup)\n  - [Development](#development)\n  - [Running the Application](#running-the-application)\n  - [Scripts](#scripts)\n  - [License](#license)\n\n---\n\n## Prerequisites\n\n- **Node.js** (v20.6.0 or higher) installed on your system (required to support the `--env-file` and `--watch` options in your backend scripts)\n- **MongoDB** instance or MongoDB Atlas setup\n- **npm** or **yarn** package manager\n\n---\n\n## Cloning the Project\n\nYou can clone this repository from GitHub using the following command:\n\n```bash\ngit clone https://github.com/deividas-butkus/galutinis-projetas-CA.git\n```\n\nAfter cloning the repository, follow the setup instructions below for both the frontend and backend.\n\n---\n\n## Frontend (Client) Setup\n\n### Tech Stack\n\n- React\n- React Router DOM\n- Material UI\n- Styled Components\n- Vite (for development)\n\n### Steps to Run the Frontend\n\n1. Navigate to the `client` directory:\n\n   ```bash\n   cd client\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Run the development server:\n\n   ```bash\n   npm run dev\n   ```\n\n4. The app will run by default at `http://localhost:5173` unless otherwise configured.\n\n---\n\n## Backend (Server) Setup\n\n### Tech Stack\n\n- Express\n- MongoDB\n- CORS\n- Environment variables\n\n### Requirements\n\n- **Node.js v20.6.0 or higher**: This version is required to support the `--env-file` and `--watch` options in the development script.\n\n### Steps to Run the Backend\n\n1. Navigate to the `server` directory:\n\n   ```bash\n   cd server\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Copy the provided `.env.example` file and rename it to `.env`:\n\n   ```bash\n   cp .env.example .env\n   ```\n\n4. Change the provided `.env.example` file to `.env`and update it with your configuration details:\n\n   ```ini\n   SERVER_PORT=5001\n   CLIENT_PORT=5173\n   DB_USER=\u003cyour_db_username\u003e\n   DB_PASSWORD=\u003cyour_db_password\u003e\n   DB_CLUSTER=\u003cyour_cluster_name\u003e\n   DB_NAME=\u003cyour_database_name\u003e\n   ```\n\n   Ensure that your MongoDB credentials and cluster information are filled in correctly.\n\n5. Run the backend server:\n\n   ```bash\n   npm run dev\n   ```\n\n6. The backend server will run on `http://localhost:5001` by default.\n\n---\n\n## Development\n\n### Folder Structure\n\n- `client/src/components`:\n\n  - `atoms`: Contains reusable components like `Avatar`, `Button`, `Counter`and others.\n  - `molecules`: Contains reusable components like `ChatCard`, `MessageCard`, `InputWithLabels` and others.\n  - `organisms`: Contains specific main components like `Chat`, `Chats`, `Contacts`, and others, which are wrapped with `Footer`, and `Header` in `App` routes using `templates` folder containing `Layout`.\n\n- `server/src/routes`: Contains Express routes like `users.js`, `chats.js`, `messages.js` for handling API requests.\n\n---\n\n## Running the Application\n\n1. Ensure both frontend and backend servers are running:\n\n   - Frontend at `http://localhost:5173`\n   - Backend at `http://localhost:5001`\n\n2. The client communicates with the server for book-related data using REST APIs.\n\n---\n\n## Scripts\n\n### Frontend:\n\n- `npm run dev`: Runs the Vite development server.\n- `npm run build`: Builds the production-ready files.\n\n### Backend:\n\n- `npm run dev`: Runs the Express backend server using the `.env` configuration.\n\n---\n\n## License\n\nThis project is licensed under the ISC License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeividas-butkus%2Ffinal-project-evaluation-ca","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeividas-butkus%2Ffinal-project-evaluation-ca","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeividas-butkus%2Ffinal-project-evaluation-ca/lists"}