Skip to content

Commit

Permalink
added: developer-portal code
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexnorvag committed Sep 12, 2024
1 parent 3717578 commit 1323c59
Show file tree
Hide file tree
Showing 693 changed files with 54,371 additions and 3,660 deletions.
66 changes: 48 additions & 18 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,24 +1,54 @@
# Logs
logs
*.log
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local
# Common Examples
**/keys**

# .NET Examples
**/bin**
**/obj**

# JS / TS Examples
**/node_modules

# Editor directories and files
.vscode/*
!.vscode/extensions.json
# vscode
.vscode

# markdownlint
.markdownlint.json

# intellij
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

# Auto generated content like CIPs, Rust Library, Token Registry and Changelog
/docs/governance/cardano-improvement-proposals/*
/docs/governance/cardano-problem-statements/*
/static/img/cip/*
/static/img/cps/*
/docs/native-tokens/token-registry/*
/docs/get-started/cardano-serialization-lib/*
**/changelog

# (only check in yarn.lock when deliberately establishing a software baseline)
yarn.lock

# Temporary files that sometimes get checked in by accident
.yarn/**
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
16.14
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.17.0
1,692 changes: 1,692 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contribute to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best, not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing to the Developer Portal

👍🎉First of all, thank you for taking the time to contribute!🎉👍

The following is a set of guidelines for contributing to the Developer Portal, which are hosted in the [Cardano Foundation](https://www.github.com/cardano-foundation) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## Code of Conduct

See [CODE_OF_CONDUCT.md](https://github.com/cardano-foundation/developer-portal/blob/staging/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct)

## I don't want to read all of this, I just have a question!

Please check out our [Discussions section](https://github.com/cardano-foundation/developer-portal/discussions). Maybe you find a thread that answers your questions. If not, feel free to [open a new thread](https://github.com/cardano-foundation/developer-portal/discussions/new) and explain what you are wondering about.

Discussions are also the place to talk about your ideas on how to improve the portal and engage with the developers.

## Project structure

Make yourself familiar with the [Project Structure](https://developers.cardano.org/docs/portal-contribute/#project-structure).

We try to keep everything as simple as possible, but not simpler. If you see something that could be improved, you are encouraged to raise an issue wherein you propose your changes and explain the rationale.

## Project Showcase

The project showcase should be a place where someone new to the ecosystem can come to see what can be done - it should not be seen as a database where every project is promoted.

### Adding your own project

Read the **requirements** and follow the **instructions** in the header of the [src/data/showcases.js](https://github.com/cardano-foundation/developer-portal/edit/staging/src/data/showcases.js) file

#### A word about project descriptions

Descriptions help users find a project they are interested in and decide whether to visit the links you provided. Use relevant keywords and describe what your project is all about or what it does. Don't include claims in your description like *the **best** wallet*, *the **first** ABC* or *the **only** XYZ*. We will ask you to change the description in your pull request before merging. @TODO rationale?

## Builder Tools

This section features tools that help developers build on Cardano.

### Adding your own tool

Read the **requirements** and follow the **instructions** in the header of the [src/data/builder-tools.js](https://github.com/cardano-foundation/developer-portal/edit/staging/src/data/builder-tools.js) file.

## Pull Requests

To maintain the quality of content on the developer portal, we use pull requests to integrate changes from contributors.

Please follow these steps to have your contribution considered by the maintainers:

1. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md)
2. Follow the [styleguides](https://developers.cardano.org/docs/portal-style-guide/)
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track and resolve that problem.</details>

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Cardano Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
57 changes: 52 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,55 @@
# React + Vite
[![Netlify Status](https://api.netlify.com/api/v1/badges/8d3fae14-1136-4a30-8224-f5602a5a2360/deploy-status)](https://app.netlify.com/sites/staging-dev-portal/deploys)

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
# Cardano Developer Portal

Currently, two official plugins are available:
We wanted to build a developer portal as open and inclusive as Cardano. A portal that is in the hands of the Cardano community and can be constantly evolved by it.

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
For this to be successful, the portal relies on your contributions, and the fact that you are reading this text probably means that you have something to contribute, even if you are not a Developer.

Please find a detailed installation guide on [developers.cardano.org/docs/portal-contribute/](https://developers.cardano.org/docs/portal-contribute#installation).


## Requirements:

[Node.js](https://nodejs.org/en/download/) version >= 16.14
[Yarn](https://yarnpkg.com/en/) version >= 1.5
On macOS you also need Xcode and Command Line Tools.


## Clone the repo

```console
git clone https://github.com/cardano-foundation/developer-portal.git
```

## Navigate into the folder

```console
cd developer-portal
```

## Install all dependencies

```console
yarn install
```

## Production build

Create at least once a production build (as this pulls missing files)

```console
yarn build
```

## Local development

```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

## Project structure

Please find the project structure and more detailed information on [developers.cardano.org/docs/portal-contribute/](https://developers.cardano.org/docs/portal-contribute/#project-structure).
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
};
45 changes: 45 additions & 0 deletions blog/2020-11-01-november.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
slug: november-spotlight-2020
title: "Cardanoscan.io and PoolTool.io"
author: Cardano Foundation
author_title: Developer Spotlight
author_url: https://github.com/cardano-foundation
author_image_url: https://avatars.githubusercontent.com/u/37078161?s=200&v=4
tags: [pooltools, explorers]
description: Cardano Developer Spotlight March 2021
image: https://developers.cardano.org/img/og/og-blog-cardanoscan.png
---

Welcome to the November Developer Spotlight 2021. This month, we will focus on block explorers and pool tools. Read on to learn about the **Cardanoscan** and the **PoolTool**.

<!-- truncate -->

## 1. Cardanoscan.io

![title image](/img/spotlight/cardanoscan.png)

[Cardanoscan.io](https://cardanoscan.io/) is both a block explorer and pool tracking tool, built and operated by Cardano community member Ashish Prajapati. Cardano Scan easily lets users view recent transactions on the Cardano blockchain, explore recent blocks, and discover insightful metrics, such as the total number of active stake pools, and the total amount of ada staked on the network.

One feature that particularly stands out about Cardano Scan is the transaction visualization, which shows a graph of transactions from the last 15 days, or three epochs.

If you would like an easy and feature-rich way to explore the Cardano blockchain, then Cardano Scan is definitely worth checking out. Thank you, Cardano Scan for your efforts, keep building!

Follow Cardanoscan.io on [Twitter](https://twitter.com/cardanoscanio).

## 2. PoolTool.io

![title image](/img/spotlight/pooltool.png)

Similar to CardanoScan.io, [PoolTool.io](https://pooltool.io/) is a Cardano block explorer, albeit with some unique features and visualizations that make it a very interesting tool to explore.

The ‘Network Health’ section of PoolTool.io contains several useful charts and trackers which present easy-to-digest information on metrics such as community produced blocks, pool propagation times, historical block height alignment, and more.

Those monitoring the Cardano network are sure to find PoolTool.io useful, so check them out if you haven’t already. Thank you for your efforts PoolTool.io, and keep on building!

You can follow PoolTool.io on Twitter [here](https://twitter.com/PooltoolI).

## The Cardano Developer Spotlight

Each month, the Cardano Foundation will be selecting a couple of interesting community-led projects to discover and share with our wider ecosystem. We hope this will encourage those who are already building solutions on Cardano to keep moving forward, while also helping to inspire those thinking of building on Cardano to get started and collaborate.

If you want to draw attention to a project, please introduce it in the [developer forums](https://forum.cardano.org/c/developers/29) under "Cardano Projects".
Loading

0 comments on commit 1323c59

Please sign in to comment.