Skip to content

latifniz/your-drive

Repository files navigation

YourDrive

About

YourDrive is a Node.js application built with Express.js, Sequelize, and PostgreSQL. This project provides a RESTful API for Using Github as Your Personal Cloud Storage.

Setup

Prerequisites

  • Node.js (version 14 or higher)
  • npm (version 6 or higher)
  • PostgreSQL (version 13 or higher)

Installation

  1. Clone the repository: git clone https://github.com/anoniz/your-drive.git
  2. Install dependencies: npm install
  3. Create a .env file with the sample.env or just rename it to .env:
  4. Replace the placeholders with your actual database credentials.
  5. You have to manually insert github account credentials in db before running.

Running the Application

  1. Start the application: npm run dev
  2. Open your web browser and navigate to http://localhost:3000/api/v1/docs

Watch the video

Development

Running Tests

  • Coming soon!

Building the Application

  • Coming soon!

Contributing

Contributions are welcome! If you'd like to contribute to this project, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the ISC License.

Acknowledgments

  • bcrypt for password hashing
  • dotenv for environment variables
  • express for building the RESTful API
  • morgan for logging
  • multer for file uploads
  • pg and pg-hstore for PostgreSQL database interactions
  • sequelize for ORM
  • swagger-jsdoc and swagger-ui-express for API documentation
  • winston for logging

Discord

Contact

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published