Beauty Saurus Save

๐Ÿฆ– Beautiful Docusaurus โœจ Easy-Starter โœจ Project

Project README

:sparkles: Beauty-Saurus :sparkles:

PRs Welcome Netlify Status

Static Site Generator GUI Customize Tool Easy-Starter Project based on Docusaurus ๐Ÿฆ–

:bulb: Introduction

  • Easy to Start

    It is easy to use even if you're a beginner

  • Development beginner? It's OK!๐Ÿ‘Œ

    You can use the Beauty-Saurus by simply using the command below!

  • Intuitive design

    It has an easy and convenient design

  • GUI Customizable

    Beauty-Saurus provides convenience with a powerful GUI:art:

:mag: About

Beauty-Saurus is a GUI program that makes it easy to create static site pages such as blogs and tutorials. Beauty-Saurus makes it easier to create a website using Docu-Saurus, a simple SSG created by Facebook. It is designed to customize and distribute your site locally with several instructions. Create your own site easily and freely through Beauty-Saurus!



Beauty-Saurus was created with TypeScript, React, Redux, Node, Express, Webpack, Google Material Design, ESLint, among other awesome open-source software.

๐Ÿšฉ How to use Beauty-Saurus?

:seedling: Pre-Installation

Before working on Beauty-Saurus locally, you must have ...

  • node
  • yarn or npm

๐Ÿ“ฆ Installation

$ git clone https://github.com/Beauty-Saurus/Beauty-Saurus.git

simply clone the repeository and install it

๐ŸŽจ GUI Setting Program Run

$ yarn setting

Decorate the site with a Beauty-Saurus GUI Program ! For more detailed guidelines, please refer to this link. Beauty-Saurus Guide Page

โœ… COMPLETE

$ yarn start

Your own site has been created!

Improvements of code and issues of bugs Reports are always welcome. Please contribute in Beauty-Saurus through the issue page!

:page_facing_up: Website

This website is built using Docusaurus 2, 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

$ GIT_USER=<Your GitHub username> USE_SSH=true 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.


:sparkles: Beauty-Saurus :sparkles:

PRs Welcome Netlify Status

์ •์  ์‚ฌ์ดํŠธ ์ œ๋„ˆ๋ ˆ์ดํ„ฐ GUI Customize Tool Docusaurus๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ํ•œ Easy-Starter ํ”„๋กœ์ ํŠธ ๐Ÿฆ–

:bulb: Introduction

  • ์‰ฌ์šด ์‹œ์ž‘

    ์ดˆ๋ณด์ž๋„ ์‰ฝ๊ฒŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค

  • ๊ฐœ๋ฐœ ๊ฒฝํ—˜์ด ์—†๋‹ค๊ตฌ์š”? It's OK!๐Ÿ‘Œ

    ์•„๋ž˜์˜ ๋ช…๋ น์–ด๋งŒ ์ด์šฉํ•˜์‹œ๋ฉด Beauty-Saurus๋ฅผ ์ด์šฉํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค!

  • ์ง๊ด€์ ์ธ ๋””์ž์ธ

    ์‰ฝ๊ณ  ํŽธ๋ฆฌํ•˜๊ฒŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋„๋ก ๋””์ž์ธ๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

  • GUI๋กœ ์ปค์Šคํ…€ ๊ฐ€๋Šฅ

    ๋„ํ์‚ฌ์šฐ๋ฅด์Šค๋Š” GUI๋กœ ๊ฐ•๋ ฅํ•œ ํŽธ๋ฆฌํ•จ์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค. :art:

:mag: About

Beauty-Saurus๋Š” ๋ธ”๋กœ๊ทธ, ํŠœํ† ๋ฆฌ์–ผ๊ณผ ๊ฐ™์€ ์ •์  ์‚ฌ์ดํŠธ ํŽ˜์ด์ง€๋ฅผ ์‰ฝ๊ฒŒ ๋งŒ๋“ค ์ˆ˜ ์žˆ๋Š” GUI ํ”„๋กœ๊ทธ๋žจ์ž…๋‹ˆ๋‹ค. Beauty-Saurus๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด Facebook์—์„œ ๋งŒ๋“  ๊ฐ„๋‹จํ•œ SSG์ธ Docu-Saurus๋ฅผ ํ™œ์šฉํ•œ ์›น ์‚ฌ์ดํŠธ๋ฅผ ๋” ์‰ฝ๊ฒŒ ๋งŒ๋“ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์—ฌ๋Ÿฌ ์ง€์นจ์— ๋”ฐ๋ผ ์‚ฌ์ดํŠธ๋ฅผ ๋กœ์ปฌ์—์„œ ์‚ฌ์šฉ์ž๋ฅผ ์ง€์ •ํ•˜๊ณ  ๋ฐฐํฌํ•˜๋„๋ก ์„ค๊ณ„๋˜์—ˆ์Šต๋‹ˆ๋‹ค.

Beauty-Saurus๋ฅผ ํ†ตํ•ด ์‰ฝ๊ณ  ์ž์œ ๋กญ๊ฒŒ ๋‚˜๋งŒ์˜ ์‚ฌ์ดํŠธ๋ฅผ ๋งŒ๋“ค์–ด๋ณด์„ธ์š”!



Beauty-Saurus๋Š” ๋‹ค๋ฅธ ๋ฉ‹์ง„ ์˜คํ”ˆ ์†Œ์Šค ์†Œํ”„ํŠธ์›จ์–ด ์ค‘์—์„œ๋„ TypeScript, React, Redux, Node, Express, Webpack, Google Material Design, ESLint๋กœ ๋งŒ๋“ค์–ด์กŒ์Šต๋‹ˆ๋‹ค.

๐Ÿšฉ Beauty-Saurus ์‚ฌ์šฉ๋ฒ•

:seedling: ์‚ฌ์ „ ์„ค์น˜ ์‚ฌํ•ญ

Beauty-Saurus๋ฅผ ๋กœ์ปฌ์—์„œ ์ž‘์—…ํ•˜๊ธฐ ์ „์— ๋‹ค์Œ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

  • node
  • yarn ํ˜น์€ npm

๐Ÿ“ฆ ์„ค์น˜

$ git clone https://github.com/Beauty-Saurus/Beauty-Saurus.git

์ €์žฅ์†Œ๋ฅผ ๋ณต์ œํ•˜๊ณ  ์„ค์น˜ํ•˜๊ธฐ๋งŒ ํ•˜๋ฉด ๋ฉ๋‹ˆ๋‹ค.

๐ŸŽจ GUI ์„ค์ • ํ”„๋กœ๊ทธ๋žจ ์‹คํ–‰

$ yarn setting

Beauty-Saurus์˜ GUI ํ”„๋กœ๊ทธ๋žจ์œผ๋กœ ์‚ฌ์ดํŠธ๋ฅผ ๊พธ๋ฉฐ๋ณด์„ธ์š”! ์ž์„ธํ•œ ๊ฐ€์ด๋“œ๋Š” Beauty-Saurus Guide Page ๋ฅผ ์ฐธ์กฐํ•˜์„ธ์š”.

โœ… ์™„์„ฑ!

$ yarn start

์ถ•ํ•˜๋“œ๋ฆฝ๋‹ˆ๋‹ค. ๋‹น์‹ ๋งŒ์˜ ์‚ฌ์ดํŠธ๊ฐ€ ๋งŒ๋“ค์–ด์กŒ์Šต๋‹ˆ๋‹ค!

์ฝ”๋“œ ๊ฐœ์„  ๋ฐ ๋ฒ„๊ทธ ์‹ ๊ณ ๋Š” ์–ธ์ œ๋‚˜ ํ™˜์˜์ž…๋‹ˆ๋‹ค. ์ด์Šˆ ํŽ˜์ด์ง€๋ฅผ ํ†ตํ•ด Beauty-Saurus์— ๊ธฐ์—ฌํ•ด์ฃผ์„ธ์š”!

:page_facing_up: Website

์ด ์›น์‚ฌ์ดํŠธ๋Š” ์ตœ์‹  ์ •์  ์›น์‚ฌ์ดํŠธ ์ƒ์„ฑ๊ธฐ์ธ Docusaurus 2 ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ตฌ์ถ•๋˜์—ˆ์Šต๋‹ˆ๋‹ค

Installation

$ yarn

Local Development

$ yarn start

์ด ๋ช…๋ น์€ ๋กœ์ปฌ์˜ ๊ฐœ๋ฐœ ์„œ๋ฒ„๋ฅผ ์‹œ์ž‘ํ•˜๊ณ  ๋ธŒ๋ผ์šฐ์ € ์ฐฝ์„ ์—ฝ๋‹ˆ๋‹ค. ๋Œ€๋ถ€๋ถ„์˜ ๋ณ€๊ฒฝ ์‚ฌํ•ญ์€ ์„œ๋ฒ„๋ฅผ ๋‹ค์‹œ ์‹œ์ž‘ํ•˜์ง€ ์•Š๊ณ ๋„ ์‹ค์‹œ๊ฐ„์œผ๋กœ ๋ฐ˜์˜๋ฉ๋‹ˆ๋‹ค.

Build

$ yarn build

์ด ๋ช…๋ น์€ build ๋””๋ ‰ํ† ๋ฆฌ์— ์ •์  ์ฝ˜ํ…์ธ ๋ฅผ ์ƒ์„ฑํ•˜๊ณ  ์ •์  ์ฝ˜ํ…์ธ  ํ˜ธ์ŠคํŒ… ์„œ๋น„์Šค๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ œ๊ณตํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

ํ˜ธ์ŠคํŒ…์„ ์œ„ํ•ด GitHub ํŽ˜์ด์ง€๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒฝ์šฐ ์ด ๋ช…๋ น์€ ์›น์‚ฌ์ดํŠธ๋ฅผ ๊ตฌ์ถ•ํ•˜๊ณ  gh-pages ๋ธŒ๋žœ์น˜๋กœ ํ‘ธ์‹œํ•˜๋Š” ํŽธ๋ฆฌํ•œ ๋ฐฉ๋ฒ•์ž…๋‹ˆ๋‹ค.

Open Source Agenda is not affiliated with "Beauty Saurus" Project. README Source: Beauty-Saurus/Beauty-Saurus
Stars
55
Open Issues
3
Last Commit
1 year ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating