Skip to content

Latest commit

 

History

History
195 lines (142 loc) · 5.8 KB

README.md

File metadata and controls

195 lines (142 loc) · 5.8 KB
Raw

Contributors Froks Issues Licence


DATA BUCKET 🗃️

An awesome Mini drop box with minimalistic features
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project 🚀

main-shot

There are many so many great data sharing platforms available on internet, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a fast and scalable data bucket for sharing data between devices of a single user. This repo contains web and server part. Apps for other platforms will be coming soon...

Here's why:

  • You can share data fastly and fetch from anywhere
  • Data bucket means any kind of data text and file
  • If you are frustrated about manually copying data between devices, this is for you

Of course, no one project serve all features since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this project!

Built With

react typescript node mongodb

Getting Started

Platform Folder
Mobile Appmobile
Web Appweb
Rest Apiserver

To run and rebuild project locally in any enviroment you want these things 👇

Prerequisites

  • npm 
    npm install npm@latest -g

Installation

Backend

  1. Configure aws and Get API keys 📖 Working with s3 bucket , Get aws credentials

  2. Configure mongoDb database 📖 Connect with mongoDb atlas

  3. Clone the repo

    git clone https://github.com/shah21/Data-Bucket.git

  4. Install NPM packages

    npm install

  5. Enter your API keys and Database credentials in .env 🗒️ You can find example .env file from repo.

     API_KEY = ENTER YOUR API
 DB_USER = USER_NAME
 etc...

Frontend (Web)

  1. Install NPM packages

    npm install

  2. Change host ( server address ) on axios/config.ts ( if you want to run project locally )

    const host = window.location.host;
const BASE_URL = `http://${host}`;

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Data-Bucket is open to contributions, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📖 Learn more about open source contribution

License

Distributed under the Apache License 2.0 License. See LICENSE for more information.

Contact

Muhsin Shah - @shah21 - muhsinshah21@gmail.com

Project Link: https://github.com/shah21/Data-Bucket.git