Git Product home page Git Product logo

alx-files_manager's Introduction

Files Manager

Overview

This project is a summary of the back-end trimester at Holberton School, focusing on authentication, NodeJS, MongoDB, Redis, pagination, and background processing. The objective is to build a simple platform to upload and view files, incorporating user authentication via tokens, listing files, uploading new files, changing file permissions, viewing files, and generating thumbnails for images.

Project Details

  • Language: JavaScript (ES6)
  • Back-end Technologies: NodeJS, ExpressJS
  • Databases: MongoDB, Redis
  • Background Processing: Kue

Team

  • CTO: Guillaume, CTO at Holberton School
  • Your Team: Silas Mungiria

Timeline

  • Start Date: Feb 8, 2024, 6:00 AM
  • End Date: Feb 15, 2024, 6:00 AM
  • Checker Release Date: Feb 10, 2024, 12:00 AM
  • Manual QA Review: Must be done after completing the project
  • Auto Review: Will be launched at the deadline

Tasks

  1. Redis Utils: Create a class for managing Redis connections and operations.
  2. MongoDB Utils: Create a class for managing MongoDB connections and operations.
  3. First API: Set up the Express server and define basic endpoints for checking status and retrieving statistics.
  4. Create a New User: Implement an endpoint for creating new users with email and password.
  5. Authenticate a User: Implement endpoints for user authentication, token generation, and token-based user retrieval.
  6. First File: Implement an endpoint for uploading files and storing them in the database and disk.
  7. Get and List Files: Implement endpoints for retrieving individual files and listing files with pagination.
  8. File Publish/Unpublish: Implement endpoints for setting files as public or private.
  9. File Data: Implement an endpoint for retrieving the content of a file.

Usage

  1. Clone the repository: git clone https://github.com/mugambi12/alx-files_manager
  2. Install dependencies: npm install
  3. Start the server: npm start

Requirements

  • Node Version: 12.x.x
  • Operating System: Ubuntu 18.04 LTS
  • Allowed Editors: vi, vim, emacs, Visual Studio Code
  • Linting: ESLint

Additional Notes

  • Ensure all files end with a new line.
  • Perform linting using ESLint.
  • For running the server, set the PORT environment variable or use the default port 5000.

Resources

  • Node.js Getting Started
  • Express Getting Started
  • MongoDB Documentation
  • Redis Documentation
  • Bull Documentation
  • Image Thumbnail Documentation
  • Mime-Types Documentation

Learning Objectives

Upon completion of this project, you should be able to:

  • Create an API with Express.
  • Implement user authentication.
  • Store data in MongoDB and Redis.
  • Setup and use background workers.

alx-files_manager's People

Contributors

mugambi12 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.