Skip to content

Commit 043b65f

Browse files
arctic-hen7arctic-hen7
committed
docs: 📝 added repo docs
1 parent 7ea3ec0 commit 043b65f

File tree

3 files changed

+229
-4
lines changed

3 files changed

+229
-4
lines changed

‎CODE_OF_CONDUCT.md

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[[email protected]](mailto:[email protected]).
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations
134+

‎CONTRIBUTING.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing
2+
3+
First off, thanks so much for taking the time to contribute to Perseus, it's greatly appreciated!
4+
5+
## I just want to propose something
6+
7+
If you just want to let us know about a bug, or propose a new feature, please [open an issue](https://github.com/arctic-hen7/perseus/issues/new/choose) on this repository. We'll take a look as soon as possible!
8+
9+
## I want to help
10+
11+
That's fantastic! You can check out the [roadmap](./README.md#Roadmap) or the [issues](https://github.com/arctic-hen7/perseus/issues) to see what's currently needing to be done. If you want to work on something that's not on there, please [file an issue](https://github.com/arctic-hen7/perseus/issues/new/choose) and we'll take a look it as soon as possible!
12+
13+
## How do I contribute?
14+
15+
Contributing to a project on Github is pretty straight forward. If this is you're first time contributing to a project, all you need to do is fork this repository to your own GitHub account, add then change the code you want to (usually on your local machine, you'd pull your fork down). Commit your changes as necessary, and when you're done, submit a pull request on this repository and we'll review it as soon as possible!
16+
17+
Make sure your code doesn't break anything existing, that all tests pass, and, if necessary, add tests so your code can be confirmed to work automatically.
18+
19+
After you've submitted a pull request, a maintainer will review your changes. Unfortunately, not every pull request will be merged, but we'll try to request changes so that your pull request can best be integrated into the project.
20+
21+
## Building and Testing
22+
23+
Perseus uses [Bonnie](https://github.com/arctic-hen7/bonnie) for command aliasing, and most of the project work is done on the `showcase` example, which is used for live development testing.
24+
25+
- Terminal 1
26+
- `cd examples/showcase`
27+
- `bonnie build --watch`
28+
- Terminal 2
29+
- `cd examples/showcase`
30+
- `bonnie serve`
31+
32+
Now you can make changes to the core library and enjoy! Nearly all project commands are managed with Bonnie, and you can see what everything does by checking out the various `bonnie.toml` files throughout the project!
33+
34+
## Documentation
35+
36+
If the code you write needs to be documented in, the README, the book, or elsewhere, please do so! Also, **please ensure your code is commented**, it makes everything so much easier.
37+
38+
## Committing
39+
40+
We use the Conventional Commits system, but you can commit however you want. Your pull request will be squashed and merged into a single compliant commit, so don't worry about this!

‎README.md

+55-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,62 @@
1-
# Perseus
1+
<h1 style="text-align: center;">Perseus</h1>
22

3-
> 🚧 Perseus is still under active development! Please use it with caution at this early stage! 🚧
3+
[Book][book] • [Crate Page][crate] • [API Documentation][docs] • [Contributing][contrib]
44

5-
Perseus is a frontend web development library for Rust with full support for SSR, SSG, and ISR. It wraps the excellent lower-level systems of [Sycamore](https://github.com/sycamore-rs/sycamore), adding a more familiar NextJS-like API for SSR/SSG while maintaining maximum customizability.
5+
> 🚧 Perseus is **nearly** ready for v0.1.0, but is still under construction! 🚧
66
7-
TODO
7+
Perseus is a blazingly fast frontend web development framework built in Rust with support for major rendering strategies, reactivity without a virtual DOM, and extreme customizability. It wraps the lower-level capabilities of [Sycamore](https://github.com/sycamore-rs/sycamore) and provides a NextJS-like API!
8+
9+
- ✨ Supports static generation (serving only static resources)
10+
- ✨ Supports server-side rendering (serving dynamic resources)
11+
- ✨ Supports revalidation after time and/or with custom logic (updating rendered pages)
12+
- ✨ Supports incremental regeneration (build on demand)
13+
- ✨ Open build matrix (use any rendering strategy with anything else, mostly)
14+
15+
## How to use
16+
17+
Check out the docs [here](https://arctic-hen7.github.io/perseus) (WORK IN PROGRESS!) for how to use Perseus.
18+
19+
## Aim
20+
21+
Support every major rendering strategy and provide developers the ability to efficiently create super-fast apps with Rust and a fantastic developer experience!
22+
23+
## Motivation
24+
25+
There is a sore lack of Rust frameworks for frontend development that support more than just SPAs and client-side rendering, and so Perseus was born. We need something like NextJS for WASM.
26+
27+
## Roadmap
28+
29+
### Pre-beta
30+
31+
These tasks still need to be done before Perseus can be pushed to v0.1.0.
32+
33+
- [ ] Support providing request data to SSR renderers
34+
35+
### Pre-stable
36+
37+
These tasks still need to be done before Perseus can be pushed to v1.0.0.
38+
39+
- [ ] Support custom template hierarchies
40+
- [ ] Create a custom CLI as a harness for apps without riediculous amounts of configuration needed
41+
- [ ] Support i18n out of the box
42+
- [ ] (Maybe) Implement custom router
43+
- [ ] Pre-built integrations for Actix Web and AWS Lambda
44+
45+
### Beyond
46+
47+
These tasks will be done after Perseus is stable.
48+
49+
- [ ] Integrations for other platforms
50+
51+
## Contributing
52+
53+
We appreciate all kinds of contributions, check out our [contributing guidelines](./CONTRIBUTING.md) for more information! Also, please be sure to follow our [code of conduct](./CODE_OF_CONDUCT.md).
854

955
## License
1056

1157
See [`LICENSE`](./LICENSE).
58+
59+
[book]: https://arctic-hen7.github.io/perseus
60+
[crate]: https://crates.io/crates/perseus
61+
[docs]: https://docs.rs/perseus
62+
[contrib]: ./CONTRIBUTING.md

0 commit comments

Comments
 (0)