{"id":15724682,"url":"https://github.com/davenchy/alx-files_manager","last_synced_at":"2026-02-06T08:38:26.708Z","repository":{"id":251201881,"uuid":"836542700","full_name":"Davenchy/alx-files_manager","owner":"Davenchy","description":"ALX Files Manager Team Project","archived":false,"fork":false,"pushed_at":"2024-08-11T11:32:09.000Z","size":295,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-31T11:38:08.970Z","etag":null,"topics":["backend","bull","es6","expressjs","javascript","mime-types","mongodb","nodejs","nosql","redis","thumbnails"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Davenchy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-08-01T04:29:25.000Z","updated_at":"2024-08-11T11:32:07.000Z","dependencies_parsed_at":"2024-08-11T12:38:15.863Z","dependency_job_id":null,"html_url":"https://github.com/Davenchy/alx-files_manager","commit_stats":null,"previous_names":["davenchy/alx-files_manager"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Davenchy/alx-files_manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davenchy%2Falx-files_manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davenchy%2Falx-files_manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davenchy%2Falx-files_manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davenchy%2Falx-files_manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Davenchy","download_url":"https://codeload.github.com/Davenchy/alx-files_manager/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Davenchy%2Falx-files_manager/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29155561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T07:18:23.844Z","status":"ssl_error","status_checked_at":"2026-02-06T07:13:32.659Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["backend","bull","es6","expressjs","javascript","mime-types","mongodb","nodejs","nosql","redis","thumbnails"],"created_at":"2024-10-03T22:17:36.649Z","updated_at":"2026-02-06T08:38:26.686Z","avatar_url":"https://github.com/Davenchy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Files Manager - ALX Backend Team Project\n\n## Overview\n\nThis project is a summary of the ALX back-end trimester,\ncovering essential concepts like authentication, NodeJS, MongoDB, Redis,\npagination, and background processing. The objective is to build a simple\nplatform to upload and view files with the following features:\n\n- User authentication via a token\n\n- List all files\n\n- Upload a new file\n\n- Change permission of a file\n\n- View a file\n\n- Generate thumbnails for images\n\nThis project is designed for learning purposes to assemble each piece and\nbuild a full product.\n\n## Table of Contents\n\n- [Features](#features)\n- [Concepts Covered](#concepts-covered)\n- [Project Structure](#project-structure)\n- [Setup](#setup)\n- [Usage](#usage)\n- [API Documentation](#api-documentation)\n- [Technologies](#technologies)\n- [License](#license)\n- [Authors](#authors)\n\n## Features\n\n1. **User Authentication**: Users can authenticate via tokens.\n\n2. **File Management**:\n\n      - List all files\n\n      - Upload new files\n\n      - Change file permissions\n\n      - View files\n\n      - Generate thumbnails for images\n\n## Concepts Covered\n\n- **Creating an API with Express**: Learn how to set up and manage routes,\n    handle requests and responses, and create a robust API using Express.js.\n\n- **User Authentication**: Implement token-based authentication to secure\n    the platform.\n\n- **Data Storage in MongoDB**: Store and manage file data in MongoDB.\n\n- **Temporary Data Storage in Redis**: Use Redis for caching and temporary\n    data storage.\n\n- **Background Processing**: Set up and use a background worker for tasks like\n    generating thumbnails for images.\n\n## Project Structure\n\n\u003e This is an initial template, probably will be changed later.\n\n```plaintext\n├── src\n│   ├── controllers\n│   ├── models\n│   ├── routes\n│   ├── services\n│   ├── workers\n│   ├── app.js\n│   └── server.js\n├── .env.example\n├── .gitignore\n├── package.json\n├── README.md\n└── tests\n```\n\n- `src/controllers`: Contains the controller logic for handling requests.\n- `src/models`: Contains Mongoose schemas for MongoDB.\n- `src/routes`: Defines the API endpoints.\n- `src/services`: Contains business logic and utilities.\n- `src/workers`: Contains background worker scripts.\n- `src/app.js`: Main application setup.\n- `src/server.js`: Server configuration and startup.\n- `.env.example`: Example environment variables file.\n- `tests`: Contains test cases for the application.\n\n## Setup\n\n### Prerequisites\n\n- Node.js\n- MongoDB\n- Redis\n\n### Installation\n\n1. Clone the repository:\n\n```bash\ngit clone --depth=1 https://github.com/Davenchy/alx-files_manager.git\ncd alx-files_manager\n```\n\n2. Install dependencies:\n\n```bash\nnpm install\n# or using bun node package manager\nbun install\n```\n\n3. Set up environment variables:\n\nRename the `.env.example` file to `.env` and update the values accordingly.\n\n4. Start MongoDB and Redis servers:\n\nMake sure MongoDB and Redis are running on your system.\n\n5. Start the application:\n\n```bash\nnpm start\n```\n\n## Usage\n\n### Running the Server\n\nTo start the server, use:\n\n```bash\nnpm start\n```\n\nThe server will run on `http://localhost:3000` by default.\n\n### Running Tests\n\nTo run the tests, use:\n\n```bash\nnpm test\n```\n\n## API Documentation\n\n### Endpoints\n\n- `POST /api/register`: Register a new user\n- `POST /api/login`: Authenticate a user\n- `GET /api/data`: Retrieve data from MongoDB\n- `POST /api/data`: Store data in MongoDB\n- `GET /api/temp-data`: Retrieve temporary data from Redis\n- `POST /api/temp-data`: Store temporary data in Redis\n\n## Technologies\n\n- **Express.js**: Web framework for Node.js\n- **MongoDB**: NoSQL database for data storage\n- **Redis**: In-memory data structure store for temporary data\n- **Node.js**: JavaScript runtime environment\n- **Mongoose**: ODM for MongoDB\n- **Bull**: Redis-based queue for background jobs\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE)\nfile for details.\n\n## Authors\n\n- **Fadi Asaad (Davenchy)**: [Github](https://github.com/Davenchy) [LinkedIn](https://www.linkedin.com/in/fadi-asaad)\n\n- **Mostafa Elmasry**: [Github](https://github.com/M1-Elmasry) [LinkedIn](https://www.linkedin.com/in/mostafa-elmasry-847097251)\n\n---\n\nFeel free to reach out if you have any questions or need further assistance.\nHappy coding!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavenchy%2Falx-files_manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavenchy%2Falx-files_manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavenchy%2Falx-files_manager/lists"}