{"id":13503099,"url":"https://github.com/webframework-rs/webframework","last_synced_at":"2025-03-29T13:30:48.020Z","repository":{"id":57672027,"uuid":"157771199","full_name":"webframework-rs/webframework","owner":"webframework-rs","description":"A fun to use webframework in Rust","archived":false,"fork":false,"pushed_at":"2018-12-07T09:26:31.000Z","size":92,"stargazers_count":4,"open_issues_count":4,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-05T18:17:53.954Z","etag":null,"topics":["rust","rust-library","web","webframework"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webframework-rs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-15T20:52:24.000Z","updated_at":"2019-05-04T01:30:05.000Z","dependencies_parsed_at":"2022-08-31T01:23:25.716Z","dependency_job_id":null,"html_url":"https://github.com/webframework-rs/webframework","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webframework-rs%2Fwebframework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webframework-rs%2Fwebframework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webframework-rs%2Fwebframework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webframework-rs%2Fwebframework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webframework-rs","download_url":"https://codeload.github.com/webframework-rs/webframework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222495319,"owners_count":16993289,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rust","rust-library","web","webframework"],"created_at":"2024-07-31T22:02:37.049Z","updated_at":"2024-10-31T22:31:08.641Z","avatar_url":"https://github.com/webframework-rs.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"Webframework\n============\n\n[![](https://img.shields.io/crates/d/webframework.svg?style=popout)](https://crates.io/crates/webframework)\n[![](https://docs.rs/webframework/badge.svg)](https://docs.rs/webframework/)\n\n\n`webframework` is a fun to use web-application Rust framework. It's main goals\nare: **Safety**, Fun, *Speed*. It tries to achieve this through a combination of\nconventions, derive-macros and cli tools.\n\nFor a complete example check out [the todo example](https://github.com/webframework-rs/webframework/tree/master/todo-example).\n\nIf you are looking for documentation you can find that here: **TODO**\n\nThe complete docs can be found here:\n[**Documentation**](https://docs.rs/webframework/)\n\nFeatures\n--------\n\n- Async\n- Easy to Use\n\n_More to come!_ The project is being actively developed. Feel free to join and\nhelp expand the framework.\n\nExample\n-------\n\n[You can find an example in the documentation.](https://docs.rs/webframework/)\n\nStructure\n---------\n\nThe `webframework` project is composed of different crates:\n\n- `webframework`: The main crate, and the only one an end-user should need to\n  import. It re-exports all needed internal types and also exports a prelude\n  users can use.\n- `webframework-core`: One of the inner crates, here the basic types of the\n  project are defined. This is mainly useful for the developers of the project\n  itself as well as addon crates, that want to interface with those defined\n  here.\n- `webframework-derive`: Here the main derive macros are exported from. It is\n  here, where the ergonomic macros are defined.\n\nNew crates will surely appear at a later point, however `webframework` should\nalways be the one that ties everything together.\n\n\nContributing\n------------\n\nAnyone can potentially contribute to the `webframework` project, be it by\nwriting features, adding tests or writing documentation. Reporting bugs or\nasking for help is also encouraged. Do keep in mind though that this is a\ncommunity project, meaning that any person you run into, does this in their free\ntime. So, be sure to stay respectful and bear with potential longer reply-times.\n\n### Contributing Code\n\nCode Contribution are the most welcome way of adding new features. If you need a\nfeature yourself, and could add it to the repository, feel free to open a new\npull-request or issue. If you need help, we will try to guide or mentor you on\nhow this could be done.\n\n### Contributing Tests\n\nTests are important. They allow us to be certain that features work as intended\nand that no breakage occurred after changes. This is why adding new tests is\nalways welcomed. This can be as simple as a small unit-test or a whole\nintegration test. If you are unsure what could be tested, you can write a\ndoc-test! Simply pick any method or type without a test and write an example for\nit, demonstrating what effect it has. If you need help, we will guide you.\n\n### Writing Documentation\n\nDocumentation allows anyone to learn, or review, how to use this\nframework. Thus having a lot of correct documentation is important. Thus, if you\nnotice any typo, ommission or otherwise unclear documentation, please open an\nissue, or even better open a pull request to fix it. If you feel like writing a\nbit more, guides or blog posts are also appreciated.\n\n\nRepository Conventions\n----------------------\n\nAll new features should enter the master branch through a pull request merged by\nbors. This allows us to have an ever-green, building master.\n\nGit commit messages should be in the imperative form, but this is not a hard\nrule. However, all commit messages have to be properly formatted with the\nfollowing format:\n\n`\u003ctype of change\u003e(\u003cchanged system\u003e): \u003cdescription\u003e`\n\nThe allowed types are: feat, fix, chore, test, refactor, style, docs\n\nExamples here are:\n\n- `feat(webframework): Add new Frobnarizer component`\n- `chore(webframework-core): Rename variables to be consistent in\n  Frobnarizer#foo`\n\nLicence\n=======\n\nThe `webframework` project is licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebframework-rs%2Fwebframework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebframework-rs%2Fwebframework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebframework-rs%2Fwebframework/lists"}