diff --git a/applications/ted-cahall-testfile.md b/applications/ted-cahall-testfile.md new file mode 100644 index 00000000..af3fd43e --- /dev/null +++ b/applications/ted-cahall-testfile.md @@ -0,0 +1,154 @@ +# EOS Network Foundation Grant Proposal + +- **Project Name:** Ted Cahall New Mail Test 34 +- **Team Name:** Cahall Labs, Inc. +- **EOS Payment Address:** tedcahall.gm +- **[Level](https://github.com/eosnetworkfoundation/grant-framework#grant-levels):** 2 +- **Pomelo Grant(s):** N/A +- **Project is Open-Source:** Yes +- **Project was part of Token sale:** No +- **Repository where Project resides:** https://github.com/tedcahall/marrsrename + +## Contact + +- **Contact Name:** Ted Cahall +- **Contact Email:** cahall@cahall.com +- **Website:** http://cahall.com/ + +## Project Overview + +### Overview + +- **Name:** MARRS Rename Tool TEST +- **Brief Description:** Rename the CSV files for faster ingestion +- **Relationship to EOSIO:** This project does not relate to EOSIO +- **Reason for Interest:** Testing the Grant Framework Process and PRs + +### Project Details + +- Mock-ups/designs of any UI components +- Data models of the core functionality +- API specifications of the core functionality +- An overview of the technology stack to be used +- Documentation of core components, protocols, architecture, etc. to be deployed +- PoC/MVP or other relevant prior work or research on the topic +- What your project is _not_ or will _not_ provide or implement + - This is a place for you to manage expectations and to clarify any limitations that might not be obvious + +### Ecosystem Fit + +- Where and how does your project fit into the ecosystem? +- Who is your target audience (chain/dapp/wallet/UI developers, designers, your own user base, some dapp's userbase, yourself)? +- What need(s) does your project meet? +- Are there any other projects similar to yours in the EOSIO ecosystem? + - If so, how is your project different? + - If not, are there similar projects in related ecosystems? + +## Team + +### Team members + +- **Team Leader:** Ted Cahall + +### Legal Structure +- **Registered Legal Entity:** Cahall Labs, Inc +- **Registered Address:** 123 Mainstreet, Anytown, VA, 24000 + +### Team Experience + +Expertience working with EOSIO, etc. + +### Team Org Repos + +- https://github.com/tedcahall + +### Team Member Repos + +- https://github.com/tedcahall + +### Team LinkedIn Profiles (if available) + +- https://www.linkedin.com/in/tedcahall + +## Development Status + +- links to improvement proposals or [RFPs](https://github.com/eosnetworkfoundation/grant-framework/tree/main/docs/rfps) (requests for proposal), +- academic publications relevant to the problem, +- links to your research diary, blog posts, articles, forum discussions or open GitHub issues, +- references to conversations you might have had related to this project with anyone from the EOS Network Foundation, +- previous interface iterations, such as mock-ups and wireframes. + +## Development Roadmap + +This section should break the development roadmap down into milestones and deliverables. To assist you in defining it, we have created a document with examples for some grant categories [here](../docs/grant_guidelines_per_category.md). Since these will be part of the agreement, it helps to describe _the functionality we should expect in as much detail as possible_, plus how we can verify and test that functionality. Whenever milestones are delivered, we refer to this document to ensure that everything has been delivered as expected. + +Below we provide an **example roadmap**. In the descriptions, it should be clear how your project is related to the EOS ecosystem. We _recommend_ that teams structure their roadmap as 1 milestone ≈ 1 month. + +For each milestone, + +- make sure to include a specification of your software. _Treat it as a contract_; the level of detail must be enough to later verify that the software meets the specification. +- include the amount of funding requested _per milestone_. +- include documentation (tutorials, API specifications, architecture diagrams, whatever is appropriate) in each milestone. This ensures that the code can be widely used by the community. +- provide a test suite, comprising unit and integration tests, along with a guide on how to set up and run them. +- commit to providing Dockerfiles for the delivery of your project. +- indicate milestone duration as well as number of full-time employees working on each milestone. +- **Deliverables 0a-0c are mandatory for all milestones**, and deliverable 0e at least for the last one. If you do not intend to deliver one of these, please state a reason in its specification (e.g. Milestone X is research oriented and as such there is no code to test). + +> :zap: If any of your deliverables is based on someone else's work, make sure you work and publish _under the terms of the license_ of the respective project and that you **highlight this fact in your milestone documentation** and in the source code if applicable! **Teams that submit others' work without attributing it will be immediately terminated.** + +### Milestone Summary + +- **Total Estimated Duration:** 2 months +- **Full-Time Equivalent (FTE):** 2 FTE +- **Total Costs:** 12,000 USD + +### Milestone 1 Example — Implement EOSIO Application + +- **Estimated duration:** 1 month +- **FTE:** 2 +- **Costs:** 8,000 USD + +| ID | Deliverable | Specification | +| ----- | ----------- | ------------- | +| 0a. | License | MIT / Apache 2.0 / GPLv3 / Unlicense | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) spin up one of our EOSIO nodes and send test transactions, which will show how the new functionality works. | +| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | +| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. | +| 0e. | Article | We will publish an **article**/workshop that explains [...] (what was done/achieved as part of the grant). (Content, language and medium should reflect your target audience described above.) +| 1. | Application interface to EOSIO | We will create an integration layer ... (Please list the functionality that will be implemented for the first milestone) | +| 2. | Front-End / User Interface | We will create a UI that connects to ... | +| 3. | Caching layer | We will create a caching layer ... | +| 4. | API interface to our app | We will create an API that ... | + + + +### Milestone 2 Example — Additional features + +- **Estimated Duration:** 1 month +- **FTE:** 2 +- **Costs:** 4,000 USD + +| ID | Deliverable | Specification | +| ----- | ----------- | ------------- | +| 0a. | License | MIT / Apache 2.0 / GPLv3 / Unlicense | +| 0b. | Documentation | We will provide both **inline documentation** of the code and a basic **tutorial** that explains how a user can (for example) spin up one of our EOSIO nodes and send test transactions, which will show how the new functionality works. | +| 0c. | Testing Guide | Core functions will be fully covered by unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | +| 0d. | Docker | We will provide a Dockerfile(s) that can be used to test all the functionality delivered with this milestone. | +| 0e. | Article | We will publish an **article**/workshop that explains [...] (what was done/achieved as part of the grant). (Content, language and medium should reflect your target audience described above.) +| 1. | Performance Enhancements | We will create performance enhancements to ... (Please list the functionality that will be implemented for the first milestone) | +| 2. | Added UI functionality | We will add UI functionality to... | +| 3. | Add 3rd Party API integration | We will add 3rd party integration to ... | + +## Future Plans + +- how you intend to use, enhance, promote and support your project in the short term, and +- the team's long-term plans and intentions in relation to it. + + +## Additional Information + +**How did you hear about the Grants Program?** EOS Network Foundation Website / Medium / Twitter / Element / Announcement by another team / personal recommendation / etc. + +- Work you have already done. +- If there are any other teams who have already contributed (financially) to the project. +- Previous grants you may have applied for.