{"id":21197358,"url":"https://github.com/victorpreston/alx-files_manager","last_synced_at":"2025-07-10T05:31:31.231Z","repository":{"id":244825529,"uuid":"815698631","full_name":"victorpreston/alx-files_manager","owner":"victorpreston","description":"Project is a compilation of (MERN) Back-end concepts on; Authentication, NodeJS, MongoDB, Redis, Pagination and Background processing.","archived":false,"fork":false,"pushed_at":"2024-09-01T19:07:38.000Z","size":937,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-05T04:49:45.194Z","etag":null,"topics":["alx","alx-africa","api","api-tests","backend","backend-api","file-manager","file-upload","mongodb","tests"],"latest_commit_sha":null,"homepage":"https://file-manager-api-documentation.vercel.app/","language":"JavaScript","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/victorpreston.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,"zenodo":null}},"created_at":"2024-06-15T21:51:14.000Z","updated_at":"2024-11-12T14:30:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"8dc8961d-11e3-438b-8a64-83394f6e1478","html_url":"https://github.com/victorpreston/alx-files_manager","commit_stats":null,"previous_names":["victorpreston/alx-files_manager"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/victorpreston/alx-files_manager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorpreston%2Falx-files_manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorpreston%2Falx-files_manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorpreston%2Falx-files_manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorpreston%2Falx-files_manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victorpreston","download_url":"https://codeload.github.com/victorpreston/alx-files_manager/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorpreston%2Falx-files_manager/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264535993,"owners_count":23624404,"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":["alx","alx-africa","api","api-tests","backend","backend-api","file-manager","file-upload","mongodb","tests"],"created_at":"2024-11-20T19:44:05.276Z","updated_at":"2025-07-10T05:31:31.225Z","avatar_url":"https://github.com/victorpreston.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Files Manager\n\n[![Coverage Status](https://coveralls.io/repos/github/B3zaleel/alx-files_manager/badge.svg?branch=main)](https://coveralls.io/github/B3zaleel/alx-files_manager?branch=main)\n\nA simple file management API built with Express, MongoDB, Redis, Bull, and Node.js.\n\n## Requirements\n\n### Applications\n\n+ Node.js\n+ Yarn (the package manager/resource negotiator)\n\n### APIs\n\n+ A Google API should be created with at least an email sending scope and a valid URL (e.g.; `http://localhost:5000/`) should be one of the redirect URIs. The `credentials.json` file should be stored in the root directory of this project.\n\n### Environment Variables\n\nThe required environment variables should be stored in a file named `.env` and each line should have the format `Name=Value`. The table below lists the environment variables that will be used by this server:\n\n| Name | Required | Description |\n|:-|:-|:-|\n| GOOGLE_MAIL_SENDER | Yes | The email address of the account responsible for sending emails to users. |\n| PORT | No (Default: `5000`)| The port the server should listen at. |\n| DB_HOST | No (Default: `localhost`)| The database host. |\n| DB_PORT | No (Default: `27017`)| The database port. |\n| DB_DATABASE | No (Default: `files_manager`)| The database name. |\n| FOLDER_PATH | No (Default: `/tmp/files_manager` (Linux, Mac OS X) \u0026 `%TEMP%/files_manager` (Windows)) | The local folder where files are saved. |\n\n## Installation\n\n+ Clone this repository and switch to the cloned repository's directory.\n+ Install the packages using `yarn install` or `npm install`.\n\n## Usage\n\nStart the Redis and MongoDB services on your system and run `yarn start-server` or `npm run start-server`.\n\n## Tests\n\n+ Create a separate `.env` file for the tests named `.env.test` and store the value of the environment variables for the testing event in it.\n+ Run `yarn test` or `npm run test` to execute the E2E tests.\n\n## Documentation\n\nGenerate OpenAPI documentation with [**apidoc**](https://www.npmjs.com/package/apidoc).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorpreston%2Falx-files_manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictorpreston%2Falx-files_manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorpreston%2Falx-files_manager/lists"}