Skip to content
This repository was archived by the owner on Feb 4, 2026. It is now read-only.

Commit 40fa089

Browse files
0bkevin0bkevin
authored
Add readme, code of conduct and contributions guideline (#8)
* feat: add main readme page * feat: add contributing guidelines * feat: add code of conduct
1 parent 809faef commit 40fa089

File tree

3 files changed

+300
-1
lines changed

3 files changed

+300
-1
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
2+
# 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, 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+
**team@encorpora.io**.
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.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder][mozilla coc].
124+
125+
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
129+
[mozilla coc]: https://github.com/mozilla/diversity
130+
[faq]: https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing to Corpora
2+
3+
First off, thank you for considering contributing to Corpora! 🎉 We value your time and effort. Whether you're fixing a bug, proposing a new feature, improving documentation, or writing code, your contribution is welcome and appreciated.
4+
5+
This document provides guidelines for contributing to the Corpora website project. Please take a moment to review it to ensure a smooth and effective contribution process.
6+
7+
## Code of conduct
8+
9+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to follow it to help foster an open and welcoming environment. Please report any unacceptable behavior to team@encorpora.io.
10+
11+
12+
## How can I contribute?
13+
14+
There are many ways to contribute to Corpora:
15+
16+
* **🐛 Reporting bugs:** If you find a bug, please open an issue and provide detailed steps to reproduce it.
17+
* **✨ Suggesting enhancements:** Have an idea for a new feature or an improvement to an existing one? Open an issue to discuss it.
18+
* **📝 Improving documentation:** Found a typo, an unclear explanation, or missing information in the README or other documentation? Submit a pull request with your improvements.
19+
* **💻 Writing code:** If you want to fix a bug or implement a new feature, follow the steps below.
20+
21+
## Getting started
22+
23+
1. **Ensure you have the prerequisites:** Node.js (v18+), npm/yarn/pnpm.
24+
2. **Fork the repository** on GitHub.
25+
3. **Clone your fork** locally:
26+
```bash
27+
git clone https://github.com/YOUR_USERNAME/corpora-main-page.git
28+
cd corpora-main-page/encorpora-edu
29+
```
30+
4. **Install dependencies:**
31+
```bash
32+
npm install
33+
```
34+
5. **Run the development server:**
35+
```bash
36+
npm run dev
37+
```
38+
The site should now be running at `http://localhost:3000`.
39+
40+
*(For more details, see the [README.md](README.md#set-up-guide)).*
41+
42+
## Making changes
43+
44+
1. **Create a new branch** for your changes. Use a descriptive name, like `fix/login-bug` or `feature/add-search-bar`.
45+
```bash
46+
git checkout -b <branch-name>
47+
```
48+
2. **Make your code changes.**
49+
* Follow the existing coding style and conventions.
50+
* Ensure your code is well-commented where necessary.
51+
* If adding new features, consider if unit tests are applicable.
52+
* Update documentation (like the README) if your changes affect setup, usage, or features.
53+
3. **Format and lint your code**
54+
```bash
55+
npm run lint
56+
```
57+
4. **Test your changes** thoroughly. Ensure the development server runs without errors and the website behaves as expected. Check the build process:
58+
```bash
59+
npm run build
60+
```
61+
5. **Commit your changes.** Write clear and concise commit messages. Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification if possible (e.g., `fix: correct typo in header`, `feat: implement dark mode toggle`).
62+
```bash
63+
git add .
64+
git commit -m "feat: Describe your feature"
65+
```
66+
67+
## Submitting a Pull Request (PR)
68+
69+
1. **Push your branch** to your fork on GitHub:
70+
```bash
71+
git push origin <branch-name>
72+
```
73+
2. **Open a Pull Request** from your fork's branch to the `main` branch of the `corpora-inc/corpora-main-page` repository.
74+
3. **Create a description** Clearly describe the problem you are solving and the changes you made.
75+
* Link to any relevant issues (e.g., "Closes #123").
76+
* Include screenshots or GIFs if your changes affect the UI.
77+
4. **Request reviews** if needed, or wait for maintainers to review your PR.
78+
5. **Respond to feedback** and make necessary changes. Push updates to your branch; the PR will update automatically.
79+
6. Once your PR is approved and passes any automated checks, a maintainer will merge it.
80+
81+
## Issue and Pull Request labels
82+
83+
We may use labels to categorize issues and PRs (e.g., `bug`, `enhancement`, `documentation`, `help wanted`). This helps organize tasks and guide contributors.
84+
85+
## Getting help
86+
87+
If you have questions about contributing, feel free to:
88+
89+
* Open an issue with the `question` label.
90+
* Contact the team at team@encorpora.io.
91+
92+
Thank you again for your interest in contributing to Corpora!

‎README.md‎

Lines changed: 78 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,78 @@
1-
# encorpora.io
1+
# Corpora Inc - Official Website
2+
3+
Welcome to the repository for the official website of **Corpora** This Next.js application serves as the main online presence for our organization.
4+
5+
## Our Mission
6+
7+
> At Corpora, we believe that learning should be as direct and friction-free as possible. We build offline-first apps and hand-crafted books that cut out distractions and get straight to the heart of every subject. No ads. No trackers. Just pure, focused education—because the best way to master something is to eliminate everything that gets in the way.
8+
9+
## Key Features
10+
11+
- **📚 Focused Learning:** Hand-crafted books and apps designed for deep understanding without distractions.
12+
- **🔒 Absolute Privacy:** Your data stays yours. We implement zero data collection and zero tracking, ever.
13+
- **✈️ Offline-First:** Access educational content anytime, anywhere. Our resources are built to work without needing a constant internet connection.
14+
- **🌍 Open Source:** Corpora is fully open source. We believe in collaboration and transparency to build valuable resources for humanity.
15+
16+
## ⭐ Star the Project
17+
18+
If you find this project useful or interesting, please consider giving it a star on GitHub. Your support helps us grow and reach more contributors!
19+
20+
[![Star on GitHub](https://img.shields.io/github/stars/corpora-inc/encorpora.io.svg?style=social)](https://github.com/corpora-inc/encorpora.io/stargazers)
21+
22+
23+
## 👩‍💻 Tech Stack
24+
25+
- **Framework:** [Next.js](https://nextjs.org/)
26+
- **Language:** [TypeScript](https://www.typescriptlang.org/)
27+
- **Styling:** [Tailwind CSS](https://tailwindcss.com/) with [shadcn/ui](https://ui.shadcn.com/) components
28+
- **Data:** [Supabase](https://supabase.com/) (for fetching book information)
29+
- **Deployment:** Static Export via GitHub Actions to GitHub Pages
30+
31+
## 🤝 Get involved
32+
33+
Corpora is fully open source! We welcome contributions. If you'd like to help:
34+
35+
### Prerequisites
36+
37+
- [Node.js](https://nodejs.org/) (v18 or later recommended)
38+
- [npm](https://npmjs.com/) (comes with Node.js)
39+
40+
### Set up guide
41+
42+
1. **Fork** the repository.
43+
2. **Clone the repository:**
44+
45+
```bash
46+
git clone git@github.com:corpora-inc/encorpora.io.git
47+
cd encorpora-main-page/encorpora-edu
48+
```
49+
50+
_(Replace `your-github-username` with the actual path if different)_
51+
52+
3. **Install dependencies:**
53+
```bash
54+
npm install
55+
```
56+
4. Create a new **branch** (`git checkout -b feature/YourImprovement` or `bugfix/YourFix`).
57+
5. Run the project
58+
59+
```bash
60+
npm run dev
61+
```
62+
63+
6. Make your changes.
64+
7. **Commit** your changes (`git commit -m 'Add some feature'`).
65+
8. **Push** to the branch (`git push origin feature/YourImprovement`).
66+
9. Open a **Pull Request**.
67+
68+
---
69+
70+
Follow these instructions to set up the project locally for development or contributions.
71+
72+
⭐ Feel free to open an issue on GitHub if you find bugs or have suggestions.
73+
74+
## Contact
75+
76+
- **Email:** team@encorpora.io
77+
- **GitHub:** [https://github.com/corpora-inc](https://github.com/corpora-inc)
78+
- **Website:** [https://encorpora.io](https://encorpora.io)

0 commit comments

Comments
 (0)