Skip to content

Commit

Permalink
feat: init doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chongqiangchen committed Apr 3, 2023
1 parent 6912847 commit f6a50ae
Show file tree
Hide file tree
Showing 68 changed files with 1,866 additions and 0 deletions.
20 changes: 20 additions & 0 deletions apps/doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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*
5 changes: 5 additions & 0 deletions apps/doc/.idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions apps/doc/.idea/WTF-Academy-StarkNet-Hackathon.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions apps/doc/.idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions apps/doc/.idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

93 changes: 93 additions & 0 deletions apps/doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# WTF Starknet
Todo list of WTF Starknet during Starknet Building Hacker House Tel Aviv, 31st Jan-7th Feb, 2023.

## Background
1. WTF Academy is a web3 open-source university for developers.
- WTF Solidity (5,700 ⭐): https://github.com/AmazingAng/WTF-Solidity
- WTF Ethers (1,100 ⭐): https://github.com/WTFAcademy/WTF-Ethers
- Integrated Education Platform (3,300 users): https://wtf.academy

2. WTF Starknet is a platform to onboard developers to Starknet, which includes tutorial, examples, and on-chain certificates.

## Todo and Progress

### 1. Tutorials
Minimal tutorials on Starknet, assuming the learners have Ethereum development experience.
- Account Abstraction: @ocandocrypto
- Cairo: @hasselalcala [Draft] [Quiz]
- Tooling: @hasselalcala [Draft]
- Starknet.js @AmazingAng [Draft]
- Build a minimal Dapp

### 2. Frontend

Build a website for WTF StarkWare based on Docusaurus.
- dashboard page
- tutorial page
- quiz page
- certificate page

### 3. Backend
- quiz backend @stoneworld @reborn-sama(huashui)
- certificate backend

### 4. Contract
Build a SBT contract for certificates on starknet.
- certificate contract

### 5. Design
- web design ([Figma](https://www.figma.com/file/dZiNEsfG5Nkc1uQFy3agEk)): [@tankxu](https://github.com/tankxu)
- logo design

### 6. Project Management
- github todo list [x]

## How to contribute

We will manage the project on Github (yes, this repo), so you can see all the tasks and contributors here.

1. Read [Project Brief](https://onlydust.notion.site/WTF-Academy-Starknet-cec45bfe02694dbc895eb42e8f3f1c31)
2. Contact project lead 0xAA's Telegram (@not0xAA) or [Twitter](https://twitter.com/0xAA_Science), briefly introduce yourself and which part you want to contribute to.
3. You can create a PR update your github ID after corresponding tasks, or I will do it for you.

## Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

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

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions apps/doc/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')],
};
62 changes: 62 additions & 0 deletions apps/doc/blog/2023-02-04-first-blog-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
slug: first-blog-post
title: First Blog Post
authors:
name: "0xAA"
title: Founder of WTF Academy
url: https://github.com/AmazingAng
tags: [hola, wtfacademy]
---

# **WTF Academy**

If you are reading this, thank you for choose WTF Academy! Today we want to talk about our history and how this project begins.

![](./img/history_01.png)
![](./img/history_02.png)

WTF Academy is a web3 open-source university aiming to onboard 10,000 developers to web3 space. After you complete the courses that we offer, you can claim your SBT certificate.

## How to use WTF Starknet

**To start to work in this platform.**

1. Go to main page, and click in "Starknet tutorials".

![](./img/main_page.png)

2. You will see a dashboard and your progress

![](./img/dashboard.png)

![](./img/progress.png)

3. Read chapter 1 about Account Abstraction.

![](./img/AA.png)

4. Follow the steps and create your wallet account to work in Starknet network.

*For Argent Wallet*

![](./img/argent_wallet.png)

*For Braavos Wallet*

![](./img/braavos_wallet.png)

5. Connect your wallet to the platform.

![](./img/connect_wallet.png)

![](./img/connect_wallet_02.png)


6. Answer the quizzes for each chapter.

![](./img/tutorials_done.png)

7. Once you finish all quizzes, you can claim your certificate!

![](./img/certificate.png)

Binary file added apps/doc/blog/img/AA.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/argent_wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/braavos_wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/certificate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/connect_wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/connect_wallet_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/history_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/history_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/main_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/progress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/blog/img/tutorials_done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/doc/docs/Guide/img/5-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions apps/doc/docs/Guide/readme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---

title: Guide

---

## Solive S
13 changes: 13 additions & 0 deletions apps/doc/docs/dashboard.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Dashboard
sidebar_position: 0
slug: /dashboard
hide_title: true
---

<PageMetadata
title="WTF Starknet"
description="Learning Starknet!"
image="https://gateway.pinata.cloud/ipfs/QmYDJ1c9WuqCsEPZDGo8huyCPPkYjd1WoqDvBhSbNsgtJ2/101.png"
/>

156 changes: 156 additions & 0 deletions apps/doc/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');

function defineSection(section, version = {}, options = {}) {
return [
'@docusaurus/plugin-content-docs',
/** @type {import('@docusaurus/plugin-content-docs').Options} */
({
id: section,
path: `docs/${section}`,
routeBasePath: section,
include: ['**/*.md', '**/*.mdx'],
sidebarPath: require.resolve('./sidebars-default.js'),
breadcrumbs: false,
editUrl: 'https://github.com/WTFAcademy/frontend', // TODO: 需要更改
versions: version && {
current: {
label: version.label,
},
},
...options,
}),
];
}

const SECTIONS = [
];

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "WTF Starknet",
tagline: "Onboarding Developers to Starknet",
favicon: "img/favicon.ico",

// Set the production url of your site here
url: "https://your-docusaurus-test-site.com",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "WTFAcademy", // Usually your GitHub org/user name.
projectName: "WTF-Academy-Starknet-Hackathon", // Usually your repo name.

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",

// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en", "zh"],
},

presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
theme: {
customCss: [require.resolve("./src/css/custom.css")],
},
}),
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: "img/docusaurus-social-card.jpg",
navbar: {
title: "Solive",
logo: {
alt: "Solive",
src: "img/logo_300x300.png",
},
items: [
{
type: "doc",
docId: "dashboard",
position: "left",
label: "Tutorial",
},
{ to: "/blog", label: "Blog", position: "left" },
],
},
footer: {
style: "dark",
links: [
{
title: "Docs",
items: [
{
label: "Tutorial",
to: "/docs/dashboard",
},
],
},
{
title: "Community",
items: [
{
label: "Discord",
href: "https://discord.com/invite/5akcruXrsk",
},
{
label: "Twitter",
href: "https://twitter.com/WTFAcademy_",
},
],
},
{
title: "More",
items: [
{
label: "Blog",
to: "/blog",
},
{
label: "GitHub",
href: "https://github.com/WTFAcademy/WTF-Academy-Starknet-Hackathon",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
plugins: [...SECTIONS],
};

module.exports = config;
Loading

0 comments on commit f6a50ae

Please sign in to comment.