|
1 |
| -## Project Name <!-- Add your project name here"--> |
2 |
| -<!-- Add you project logo here if available--> |
| 1 | +## Project Name |
| 2 | +Truffle Preserve |
3 | 3 |
|
4 | 4 | ## Category
|
5 |
| -<!--developer tooling, application, wallet, infrastructure, etc--> |
| 5 | +Developer Tooling |
6 | 6 |
|
7 | 7 | ## Project Description
|
8 |
| -<!--Describe your project in a few sentences. --> |
| 8 | +In thinking about our support for Filecoin, the idea of preservation came quickly to mind. We envisioned that preserving application data like Javascript frontends and static assets would be a normal part of the deployment process. So we ran with that idea and added a new command to the Truffle command line tool: truffle preserve. |
| 9 | + |
| 10 | +Like preserving fruit, Truffle follows a "recipe" to preserve your files. In the gif above, Truffle is using the filecoin recipe, which will ship standard with our new version of Truffle. To use truffle preserve, simply specify the files you want to preserve on the command line, and choose between the --filecoin or --ipfs recipes. The filecoin recipe uses the ipfs recipe under the hood. You can choose only the ipfs recipe if you have a different set up! |
9 | 11 |
|
10 | 12 | ## Project Status
|
11 |
| -<!--brainstorming, fundraising, under development, beta, shipped, etc--> |
| 13 | +Beta release & stable version under development |
12 | 14 |
|
13 | 15 | ## Previews
|
14 |
| -<!--Add some screenshots to give a preview of your product--> |
| 16 | +https://drive.google.com/file/d/1gIM416dnc2YAUYOIPu2HhkOSDaWM2G3p/view?usp=sharing |
15 | 17 |
|
16 | 18 | ## Target Audience
|
17 |
| -<!--Describe who will be your project's users--> |
| 19 | +Developers |
18 | 20 |
|
19 | 21 | ## Rough estimated user base (if applicable)
|
20 |
| -<!--How many users do you have right now?--> |
| 22 | +Truffle Suite has about 6 million downloads across our suite of tools including Truffle, Ganache, Drizzle, and Teams |
21 | 23 |
|
22 | 24 | ## Github repo
|
23 |
| -<!--Attach a link to your GitHub repo if it's OSS--> |
| 25 | +https://github.com/trufflesuite/truffle |
24 | 26 |
|
25 | 27 | ## Website
|
26 |
| -<!--Link your website if available--> |
| 28 | +https://www.trufflesuite.com/ |
27 | 29 |
|
28 | 30 | ## Docs
|
29 |
| -<!--Including a link to your project docs!--> |
| 31 | +Our docs are located here: https://www.trufflesuite.com/docs |
| 32 | +More docs for this project will be published in April 2021. |
30 | 33 |
|
31 | 34 | ## Team Info
|
32 |
| -<!-- Introduce your amazing team - how many team members are working on this project and who are they?--> |
| 35 | + |
33 | 36 | ### Team Size
|
| 37 | +Truffle Suite is a team of 13 developers working across our sweet suite of tools. |
34 | 38 |
|
35 |
| -### Team members |
| 39 | +### Team members |
| 40 | +The main developers on this projects are @gnidan and @tcoulter with help from our friend, @rkalis. |
36 | 41 |
|
37 | 42 | ## How the community can engage
|
38 |
| -GitHub Discussion: <!--Start a disucssion with the community here: https://github.com/filecoin-project/community/discussions/new and attach the link!--> |
39 |
| -Email: |
40 |
| -Slack: |
41 |
| -Twitter: |
42 |
| -Discord: |
43 |
| -Telegram: |
44 |
| -WeChat: |
| 43 | + |
| 44 | +Twitter: @trufflesuite |
| 45 | +Discord: http://trfl.co/truffle-community |
45 | 46 |
|
46 | 47 | ## How to Contribute
|
47 | 48 | <!--How can the community contribute to your project?-->
|
| 49 | +Try out Truffle Preserve and send us your feedback on Discord. We'd love to hear fromy you! |
0 commit comments