Everything you need, all in one place, instantly 📦

Technologies   |    Project   |    Getting started   |    How to contribute   |    License

🚀 Technologies

This project was developed with the following technologies:

• Node.js
• ReactJS
• React Native

Extras:

• Main Libs
  • Express
  • Next.js
  • Mongoose ODM
  • socket.io

💻 Project

RocketBox is a project where you can store your files, accessible from your computer or phone, just add your files and instantly display the content in other devices.

💺 Getting started

These instructions will get you a copy of the full project up and running on your local machine for development and testing purposes.

API and Web App

Setting up the development environment

You will need to install Git, Docker Desktop and Docker Compose before following the instructions below.

Building and running the services using Docker Compose

The following steps need to be performed inside a terminal window (Windows user may prefer to use the Windows Terminal but the Command Prompt will also work).

Clone the repository and build Docker images:

1. $ git clone https://github.com/diegomais/rocketbox.git
2. $ cd rocketbox
3. $ docker-compose build
4. $ docker-compose up

You can now use the API at http://localhost:3333 and view the Web App in the browser at http://localhost:3000.

Mobile App

Setting up the development environment

Follow the instructions for React Native CLI available in the official React Native Documentation.

Installing dependencies and running the Mobile App

Run the instructions bellow inside mobile directory:

1. npm install
2. npm start

or

1. yarn install
2. yarn start

🤔 How to contribute

• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature;
• Commit your changes: git commit -m '[feat](scope) My new feature';
• Push to your branch: git push origin my-feature.

After the merge of your pull request is done, you can delete your branch.

📝 License

This project is under the MIT license. See the LICENSE for more details.

---

Made with ❤️ by Diego Mais 👋.