Merge pull request #7 from instafluff/master

Adding Social Shareboard Project
This commit is contained in:
Sarah Guthals 2020-05-18 18:36:37 -07:00 коммит произвёл GitHub
Родитель 4c232cc1bf d7e6f82ef5
Коммит 78ecc6dd70
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
9 изменённых файлов: 181 добавлений и 0 удалений

1
.gitignore поставляемый Normal file
Просмотреть файл

@ -0,0 +1 @@
Social2020/index.html

29
Social2020/README.md Normal file
Просмотреть файл

@ -0,0 +1,29 @@
# MSBuildSocialShareboard
Social Shareboard for Microsoft Build 2020 Student Zone!
# Instructions
## Submitting a Note to the Social Shareboard
1. Fork this repository to your GitHub account with the button at the top-right
2. Create a new Markdown file in the `notes` folder inside **Social2020** and name it something unique like **ilovestudentzone2020.md** and fill it out similar to other examples in the notes folder
3. Commit and Push the changes to GitHub
4. Create a Pull Request with your changes by pressing the **New pull request** button on your repository's GitHub page and then pressing **Create pull request**
![Pull Request Example](pullrequest.png)
5. Your note will be added to the **SHAREBOARD.md** file once reviewed and approved by the admins!
## Generating the Social Shareboard
1. Make sure NodeJS is installed. You can download it at [www.nodejs.org](https://www.nodejs.org)
2. Download or Clone this repository to a folder. In a terminal window, you can type `git clone https://github.com/microsoft/StudentsAtBuild.git`
3. Open a Command Prompt/Terminal window to the **Social2020** Shareboard folder and install dependencies: `npm install`
4. Run the project with `node index.js` to scan notes and generate the **shareboard.md** and **index.html** files.
5. Open your web browser to [http://localhost:8000](http://localhost:8000) to view the page.

42
Social2020/index.js Normal file
Просмотреть файл

@ -0,0 +1,42 @@
const fs = require( "fs" );
const path = require( "path" );
const md = require( "markdown-it" )({
linkify: true,
typographer: true
}).enable([ 'link' ]);
console.log( "Scanning Social Shareboard entries..." );
let shareboardFull = fs.readdirSync( path.join( __dirname, "notes" ) )
.filter( file => path.extname( file ).toLowerCase() === ".md" )
.filter( file => file !== "sample.md" )
.map( file => fs.readFileSync( path.join( __dirname, "notes", file ) ) )
.join( "\n---\n" );
// Save the Markdown
fs.writeFileSync( "SHAREBOARD.md", shareboardFull );
// Save the HTML
let shareboard = md.render( fs.readFileSync( "SHAREBOARD.md" ).toString() );
let page = `<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/bootstrap/3.2.0/css/bootstrap.css">
<title>Social Shareboard for MS Build 2020 Student Zone!</title>
</head>
<body>
<div class="jumbotron">
<h1>#MSBuild 2020 Student Zone</h1>
<p>This is a Social Shareboard with messages submitted by participants during the Microsoft Build 2020 Student Zone event between May 19-20, 2020</p>
</div>
<br/>
<div class="container">
${shareboard}
</div>
<script src="https://cdn.jsdelivr.net/bootstrap/3.2.0/js/bootstrap.min.js"></script>
</body>
</html>`;
fs.writeFileSync( "index.html", page );
const Web = require( "webwebweb" ).Run( 8000 );

Просмотреть файл

@ -0,0 +1,9 @@
# Instafluff was at MS Build 2020
> Student Zone HYPE! Have a great MS Build and Stay Fluffy, everyone!
Join me for more fun, live-coding, and bot-building on my [Twitch channel](https://twitch.tv/instafluff) Wed-Sat (WTFS for short!)
```js
console.log( "i love lasagna!" );
```

Просмотреть файл

@ -0,0 +1,5 @@
# Name
> Quote message here!
Any text here in Markdown format

5
Social2020/notes/test.md Normal file
Просмотреть файл

@ -0,0 +1,5 @@
# Test!
> So excited for #MSBuild
Hello world!

61
Social2020/package-lock.json сгенерированный Normal file
Просмотреть файл

@ -0,0 +1,61 @@
{
"name": "msbuildsocialshareboard",
"version": "1.0.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
"argparse": {
"version": "1.0.10",
"resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz",
"integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==",
"requires": {
"sprintf-js": "~1.0.2"
}
},
"entities": {
"version": "2.0.2",
"resolved": "https://registry.npmjs.org/entities/-/entities-2.0.2.tgz",
"integrity": "sha512-dmD3AvJQBUjKpcNkoqr+x+IF0SdRtPz9Vk0uTy4yWqga9ibB6s4v++QFWNohjiUGoMlF552ZvNyXDxz5iW0qmw=="
},
"linkify-it": {
"version": "2.2.0",
"resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-2.2.0.tgz",
"integrity": "sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw==",
"requires": {
"uc.micro": "^1.0.1"
}
},
"markdown-it": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-10.0.0.tgz",
"integrity": "sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg==",
"requires": {
"argparse": "^1.0.7",
"entities": "~2.0.0",
"linkify-it": "^2.0.0",
"mdurl": "^1.0.1",
"uc.micro": "^1.0.5"
}
},
"mdurl": {
"version": "1.0.1",
"resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
"integrity": "sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4="
},
"sprintf-js": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz",
"integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw="
},
"uc.micro": {
"version": "1.0.6",
"resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
"integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA=="
},
"webwebweb": {
"version": "1.3.2",
"resolved": "https://registry.npmjs.org/webwebweb/-/webwebweb-1.3.2.tgz",
"integrity": "sha512-85g8KnAllMs5A//OOAy+0ljPOMZ+AP8+404UZ4uCuitCC3ZRwZSJFcL6mZAobUR+tb+RI3+bOjBSFizjyexNhw=="
}
}
}

29
Social2020/package.json Normal file
Просмотреть файл

@ -0,0 +1,29 @@
{
"name": "msbuildsocialshareboard",
"version": "1.0.0",
"description": "Social Shareboard for MS Build 2020 - Be a Part of MS Build 2020 Student Zone History!",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/instafluff/MSBuildSocialShareboard.git"
},
"keywords": [
"MSBuild",
"Microsoft",
"Build",
"Instafluff"
],
"author": "Instafluff",
"license": "MIT",
"bugs": {
"url": "https://github.com/instafluff/MSBuildSocialShareboard/issues"
},
"homepage": "https://github.com/instafluff/MSBuildSocialShareboard#readme",
"dependencies": {
"markdown-it": "^10.0.0",
"webwebweb": "^1.3.2"
}
}

Двоичные данные
Social2020/pullrequest.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 42 KiB