Skip to content

Commit 6e4f058

Browse files
authored
Merge pull request #220 from functionland/master
[Project submission] box
2 parents bef00ab + 5e0240e commit 6e4f058

File tree

1 file changed

+93
-0
lines changed
  • projects/developer_tooling

1 file changed

+93
-0
lines changed

projects/developer_tooling/box.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
2+
## Project Name <!-- Add your project name here"-->
3+
box
4+
5+
## Category
6+
developer tooling
7+
8+
## Project Description
9+
<!--Describe your project in a few sentences. -->
10+
The mainstream developer experience in the world of independent front-end developers is to purchase a managed service provided by a cloud vendor, which abstracts away the complexity of dealing with back-end development and enable front-end developers to focus on end-to-end user experience for their clients. Currently, there is no option for a front-end developer to build on top of IPFS with a "Developer Experience" similar to serverless functions. They need to run a full js-ipfs node on the platform they want to develop on, for example on Android, which has different file system access than iOS or other operating systems. "box" is an IPFS node which aims to separate the server from front-end development and provides front-end APIs for developers to connect to, using Libp2p, giving them the same experience as a cloud server for any "box" node. To give a full application server experience to the developer, two protocols are being developed in "box" for a start:
11+
* File Protocol
12+
* Data Protocol
13+
14+
Front-end developers work with a "box" like a server without the need to run a full IPFS node on the platform they develop for, and interface with the "box" node to store or fetch data using libp2p. End users, their clients, can treat "box" like a server to keeps their data safe and gives them all functionalities of IPFS like cluster synchronization. If they lose their phone with the application installed, their files are safe in the "box" node.
15+
16+
## Project Status
17+
<!--brainstorming, fundraising, under development, beta, shipped, etc-->
18+
We have completed the initial brainstorming and design phases, and currently completing development phase for the first prototype. Our first application is a [Google Photos Alternative](https://github.com/funcitonland/photos) which connects to the "box", and demo is ready. Currently, we are working on building [a library on top of libp2p](https://github.com/functionland/box) for upload/download of photos from the app to/from the "box".
19+
20+
## Previews
21+
<!--Add some screenshots to give a preview of your product-->
22+
![https://dev.to/fx/google-photos-open-source-alternative-with-react-native-80c](https://raw.githubusercontent.com/functionland/functionland.github.io/main/static/images/box-diagram.jpg)
23+
24+
Below is a GIF demo from "Photos" application, which is a react native app, as the first demo of how an application interacts with "box"
25+
26+
![https://dev.to/fx/google-photos-open-source-alternative-with-react-native-80c](https://raw.githubusercontent.com/functionland/blog/main/photos-intro-dev-to/photos.gif)
27+
28+
## Target Audience
29+
<!--Describe who will be your project's users-->
30+
Our primary target audience is the average front-end developers who are hands-on with managed cloud service platforms. "box" gives them the ability to develop applications on top of IPFS. Using the “graph” library, they interface with IPFS backend, through an API format that they have prior experience in.
31+
The secondary target audience is the application users who are looking for a decentralized and privay-centered alternative of paid services, such as Google Photos. They are able to turn any hardware into a back-end, and while enjoying the privacy of a private node, have the safety of cloud storage, with Filecoin and data synchronization. Thanks to Libp2p and IPFS, no static IP or domain is needed to access their “box” data from anywhere in the world.
32+
33+
## Rough estimated user base (if applicable)
34+
<!--How many users do you have right now?-->
35+
Considering Google Photos has 2B users and in most surveys at least 20% want to switch to an alternative solution after free tier being removed, there is a huge 250M potential users.
36+
The project is not live yet but our github page received around 400 stars and we have some subscribers to our newsletter.
37+
38+
## Github repo
39+
<!--Attach a link to your GitHub repo if it's OSS-->
40+
[For Photos application as the first box app](https://github.com/functionland/photos/)
41+
42+
[For box backend, which stores the data nad provides front-end API library to talk to box](https://github.com/functionland/box)
43+
44+
## Website
45+
<!--Link your website if available-->
46+
[Main website](https://fx.land)
47+
48+
[An article about box](https://dev.to/fx/google-photos-open-source-alternative-with-react-native-80c)
49+
50+
## Docs
51+
<!--Including a link to your project docs!-->
52+
https://github.com/functionland/photos/blob/main/README.md
53+
54+
## Team Info
55+
<!-- Introduce your amazing team - how many team members are working on this project and who are they?-->
56+
### Team Size
57+
4
58+
59+
### Team members
60+
**Keyvan** is an avid open-source contributor since 2012 (when he joined OpenCog's AGI development team). He holds an MSc in Artificial Intelligence from University of Southampton, UK. He's served in various technical executive positions for about a decade and been affiliated with many start-ups, including two that he co-founded.
61+
62+
* [Github Page Link](https://github.com/keyvan-m-sadeghi)
63+
* [LinkedIn Page Link](https://www.linkedin.com/in/keyvanmsadeghi/)
64+
65+
66+
**Kate** is a business development and commercialization specialist and has worked with multiple startups and SMEs to realize their non-dilutive funding, investment, and revenue generation goals. Strategic project advisor to Centennial College's projects involving machine learning. Bootstrapping a B2B marketplace technology startup in the construction sector. PhD in Plant Agriculture, Ontario Agricultural College, Msc. from Michigan State University in Crop and Soil Science with focus on statistical analysis.
67+
* [Github Page Link](https://github.com/kitty2121)
68+
* [LinkedIn Page Link](https://www.linkedin.com/in/kate-withers-hess-phd-33530023/)
69+
70+
71+
And we have two more team members with the same first name, so we added the last name too :)
72+
73+
**Ehsan Emami** is a senior hardware development lead, currently working at Amazon and previously at Apple and Gopro. With 12 years of hardware/software architecture experience, he has been a key contributer in defining, developing and fine-tuning many mass market products. Ehsan obtained his master's degree from University of Waterloo in Electrical Engineering.
74+
* [Github Page Link](https://github.com/ehsan-git-dev)
75+
* [LinkedIn Page Link](https://www.linkedin.com/in/ehsan-emami-0005bb6/)
76+
77+
78+
**Ehsan Shariati** studied electrical engineering and got his master's degree from University of Colorado at Boulder. He is a full stack developer with over 10 years of professional application development, who is experienced in Javascript frameworks, such as Angular, AngularJS, React and React Native, as well as PHP, C, C++, C#, JAVA, Python, MySQL, MSSQL, Linux. He is also a project manager, and has PMP, ITIL and SCRUM certificates. He has developed a shopping mall ERP system for the largest shopping mall in Iran(Isfahan City Center), as well as an insurance ERP for Dana insurance in Iran.
79+
* [Github Page Link](https://github.com/ehsan6sha)
80+
* [LinkedIn Page Link](https://www.linkedin.com/in/ehsanehsan/)
81+
82+
## How the community can engage
83+
GitHub Discussion: https://github.com/filecoin-project/community/discussions/217
84+
85+
Slack:
86+
Twitter: https://twitter.com/functionland
87+
Discord: https://discord.gg/ebaVDnfp
88+
Telegram: https://t.me/functionland
89+
WeChat:
90+
91+
## How to Contribute
92+
<!--How can the community contribute to your project?-->
93+
We appreciate contributions on any level, code, docs, discussions, anything! A good place to start is issues labeled as "Good first issue" over at GitHub.

0 commit comments

Comments
 (0)