Introduction
Project Name: SiaFrench
Name of the organization or individual submitting the proposal: CotradeChain
Description of your project, who benefits, and how the project will serve the Foundation’s mission of user-owned data: The Sia blockchain allows its users to access a totally autonomous and self-governed decentralized storage technology. The main problem encountered is the lack of technical documentation on its use as well as the non-possibility of being able to recover data from the network without going through the deployment of a Sia node.
The problem being addressed is the lack of comprehensive documentation for the Sia API in French and English, including information on endpoints, parameters, and responses.
Siafrench APIs provide a way for different software systems to interact with the SIA Network and easily retrieve Data without depoying a new node. It’s allowing developers to build new applications and services on top of the Sia Network. APIs can be used to access onchain data, file managing fonctionnality, or services from other applications, and can be built using a variety of programming languages and technologies.
Goal
-
Set up an open API system to facilitate interactions with Blockchain Sia. The API will include a set of requests to know the state of the network, the financial interaction data of the sia token or even data on the various actors of the network.
-
Set up an Opensource Web interface to display network data, generate and control the API interactions of its software.
-
Facilitate the onboarding of new users on the Sia network by creating a website based on Docusaurus and including courses, written and video tutorials but also by organizing a series of meetups around Sia’s decentralized storage technology for the French-speaking community and English-speaking.
Grant Specifics
#Community impact
The community impact of our project is at several levels:
-
At the level of end users and developers, our project will bring a large number of developers to understand the functioning of the Blockchain Sia. Thanks to the various Meetups organized in direct liaison with the Facebook and GDG Google developer communities in Cameroon, Senegal and Ivory Coast (more than 2,000 developers).
-
At the level of companies and young French-speaking start-ups, this will make it possible to create new projects around Sia’s storage technology.
Major requirements & deliverables
- API Deliverable :
-
Develop and publish a comprehensive documentation for the Sia API, including information on endpoints, parameters, and responses.
-
Create a developer portal that provides API keys, sample code, implementations models for different language, Datas dashboards about the current Sia Network State.
-
Implement OAuth2 authentication to secure API access and provide different levels of access to users.
-
Use RESTful architecture to make the API easy to use and integrate with other systems.
-
Create a testing sandbox environment for developers to test their applications with the API without affecting the live blockchain network.
-
Integrate webhooks to enable real-time notifications to third-party applications.
-
Implement rate limiting to prevent abuse and ensure fair usage of the API.
-
Provide analytics and usage metrics to developers to help them understand how their applications are using the API.
-
Enable CORS to allow cross-origin requests and enable more efficient data transfers.
-
Host the API on a scalable and reliable infrastructure to ensure high availability and performance.
- Learning Deliverables
Create 4 comprehensible video tutorials in French and English on:
-
The deployment of a Renterd server
-
Use of renterd for rent storage on the network
-
Installation of a mining server on the Sia network
-
Provide storage space on the Sia marketplace
Create a docusaurus website with comprehensive tutorials:
- Sia Development on Js and python
- Learning courses about Sia Network, Sia Funds and Siacoin
- Embed French developer community
Organize 3 online meetups in partnership with the French-speaking developer community in Africa GDG and FaceBook Developer (more than 2000 members).
Budget
Our detailed Spending budget :
Milestone 1 : 14000$
-
Blockchain and Backend develloper (3 months Salary) = 6000$
-
Frontend develloper (3 months Salary) = 6000$
-
Community management + Video creation (9 months Salary) = 1500$
-
AWS/Linode Cloud Services = 500$
Milestone 2 : 12500$
-
Blockchain and Backend develloper (3 months Salary) = 6000$
-
Frontend develloper (3 months Salary) = 6000$
-
Aws/Linode Cloud Services = 500$
Milestone3 : 5350$
-
Blockchain and Backend develloper maintenance and updates (6 months Fees) = 1800$
-
Frontend develloper maintenance and updates (6 months Fees) = 1800$
-
Community management + Video creation (9 months Salary) = 750$
-
AWS Cloud Services = 1000$
Total Budget: 31 850$
~#Risks and Technical Feasibility
Risks:
- Development and maintenance costs may exceed the budget.
- Technical challenges may arise that could delay the project.
- There may be difficulties in securing API access and ensuring fair usage.
- Adoption of the API may not meet expectations, leading to a lack of interest from developers.
- It can be difficult to convert Learner in permanent users of the sia blockchain technology
Technical feasibility:
- The technical feasibility of this project relies on the ability to create a scalable and reliable infrastructure to host the API. This will require a robust backend and frontend development team with experience in developing APIs.
- Implementing OAuth2 authentication, RESTful architecture, webhooks, rate limiting, analytics, and usage metrics will require significant technical expertise.
- The use of AWS Cloud Services will be essential for hosting the API and ensuring high availability and performance.
Development Information
Will all of your project’s code be open-source?: Yes it’s fully open source
Leave a link where code will be accessible for review.
SIA API : GitHub - kttm25/siafrench
Sia Learning website: https://siafrench.cotradechain.com
