Fix: Update README.md file, add code-of-conduct.md file (#926)

aragon · Jul 19, 2023 · 7b48823 · 7b48823
1 parent 392d886
commit 7b48823
Show file tree

Hide file tree

Showing 3 changed files with 149 additions and 14 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,45 +1,103 @@
-# Aragon Web App
+![Aragon](https://res.cloudinary.com/dbktgy3vg/image/upload/v1689668058/aragon-app_hpima1.png)
 
-This package holds the web-app that allows user to interact with Zaragoza. It is a [ReactJS](https://reactjs.org) based webapp.
+<p align="center">
+  <a href="https://aragon.org/">Aragon website</a>
+  •
+  <a href="https://devs.aragon.org/">Developer Portal</a>
+  •
+  <a href="https://aragonproject.typeform.com/to/LngekEhU">Join our Developer Community</a>
+  •
+  <a href="https://aragonproject.typeform.com/dx-contribution">Contribute</a>
+</p>
+
+<br/>
+
+# Aragon App
+
+The Aragon App is an easy-to-use platform that empowers users to create and manage their Decentralized Autonomous Organizations (DAOs). The application interacts with the [Aragon OSx](https://github.com/aragon/osx) through the integration of the [Aragon OSx SDK](https://github.com/aragon/sdk) and the [Aragon ODS](https://github.com/aragon/ods) library.
 
 ## Getting Started
 
-Start a Vite development server at http://localhost:3000 using
+Follow these steps to set up the Aragon App locally:
+
+1. Install the project's dependencies:
+
+```bash
+yarn install
+```
+
+2. Start the development server:
 
 ```bash
 yarn dev
 ```
 
-Other available commands include
+3. Access the Aragon App by opening [http://localhost:3000](http://localhost:3000) in your web browser.
+
+Other available commands include:
+
+- Lint the code:
 
 ```bash
 npm run lint
 ```
 
+- Build the project:
+
 ```bash
 npm run build
 ```
 
+- Run tests:
+
 ```bash
 npm run test
 ```
 
-## Tech stack
+## Environments
 
-The web-app is built using the following tools:
+The Aragon App supports various environments, each with its unique URL and deployment trigger. Here are the available environments:
+
+| Name            | Url                            | Deployment trigger                                                               | Environment file                 |
+| --------------- | ------------------------------ | -------------------------------------------------------------------------------- | -------------------------------- |
+| **Local**       | http://localhost:3000          | -                                                                                | `.env.development`               |
+| **Preview**     | [Generated by the pipelines]   | Manual by adding the `preview` label to an open Pull Request                     | `.env.staging`                   |
+| **Development** | https://app-dev.aragon.org     | Automatic on `develop` branch push or manual by the `WebApp Deploy DEV` workflow | [Depends on the selected branch] |
+| **Staging**     | https://staging-app.aragon.org | Automatic on `develop` branch push                                               | `.env.staging`                   |
+| **Production**  | https://app.aragon.org         | Automatic on `main` branch push                                                  | `.env.production`                |
+
+### Hosting
+
+The CI/CD pipelines for the Aragon App use GitHub Actions, and once completed successfully, the static site generated will be hosted on:
+
+- [Fleek](https://fleek.co): For staging and production environments.
+- [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine): For the development environment.
+
+## Tech Stack
+
+The Aragon App is built using the following tools to ensure a seamless user experience:
 
 - [ReactJS](https://reactjs.org)
 - [Vite](https://vitejs.dev)
 - [TypeScript](https://www.typescriptlang.org)
 - [Jest](https://jestjs.io)
 - [Testing Library](https://testing-library.com)
-- [Tailwindcss](https://tailwindcss.com)
-- [Eslint](https://eslint.org)
+- [Tailwind CSS](https://tailwindcss.com)
+- [ESLint](https://eslint.org)
 - [Prettier](https://prettier.io)
 
-### DevOps
+## Learn More
+
+For more information about Aragon and its ecosystem, please visit the [Aragon website](https://aragon.org/) and explore our [Developer Portal](https://devs.aragon.org/).
+
+Join our [Developer Community](https://aragonproject.typeform.com/to/LngekEhU) to stay updated and contribute to the growth of decentralized governance.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
 
-The CI/CD pipelines for the Aragon Web App use GitHub Actions, once completed successfully, the static site generated will be hosted on:
+## License
 
-- [Fleek](https://fleek.co/): For stagging on IPFS Network.
-- [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine): For development and testing.
+[GPL-V3](./LICENSE)
diff --git a/code-of-conduct.md b/code-of-conduct.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+-   The use of sexualized language or imagery and unwelcome sexual attention or
+    advances
+-   Trolling, insulting/derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or electronic
+    address, without explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
diff --git a/package.json b/package.json
@@ -1,9 +1,10 @@
 {
-  "name": "@aragon/apps-web",
-  "description": "Webapp to interact with Aragon Core",
+  "name": "@aragon/app",
+  "description": "Web application to interact with Aragon OSx",
   "version": "0.1.0",
   "private": true,
   "author": "Aragon Association",
+  "license": "GPL-3.0",
   "scripts": {
     "dev": "vite",
     "build": "tsc && cross-env NODE_ENV=production node --max_old_space_size=16384 ./node_modules/vite/bin/vite.js build --sourcemap true > build.txt",