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

Last update: May 17, 2022

โœจ Beauty-Saurus โœจ

PRs Welcome Netlify Status

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

๐Ÿ’ก 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 ๐ŸŽจ


๐Ÿ” 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?

๐ŸŒฑ Pre-Installation

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

  • node
  • yarn or npm

๐Ÿ“ฆ Installation

$ git clone https://github.com/Chloekkk/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!


๐Ÿ“„ 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=
   
     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.


โœจ Beauty-Saurus โœจ

PRs Welcome Netlify Status

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

๐Ÿ’ก Introduction

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

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

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

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

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

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

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

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


๐Ÿ” 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 ์‚ฌ์šฉ๋ฒ•

๐ŸŒฑ ์‚ฌ์ „ ์„ค์น˜ ์‚ฌํ•ญ

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

  • node
  • yarn ํ˜น์€ npm

๐Ÿ“ฆ ์„ค์น˜

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

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


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

$ yarn setting

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


โœ… ์™„์„ฑ!

$ yarn start

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

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


๐Ÿ“„ Website

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

Installation

$ yarn

Local Development

$ yarn start

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

Build

$ yarn build

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

Deployment

$ GIT_USER=
   
     USE_SSH=true yarn deploy

   

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

GitHub

https://github.com/Chloekkk/Beauty-Saurus
You might also like...

Starter project for node + react apps

docker-node-react-starter This is a starter project for a node + react app that uses docker for dev enironment. Docker and docker-compose is all you n

Jun 19, 2022

A starter project for web 3 apps

Web3 Starter Web 3 Starter is a modern web 3 starter template project. Here's the full stack of frameworks/libraries used: Next.js React TailwindCSS f

Apr 30, 2022

A starter project for web 3 apps

Web3 Starter Web 3 Starter is a modern web 3 starter template project. Here's the full stack of frameworks/libraries used: Next.js React TailwindCSS f

Dec 9, 2021

The starter code for the final assessment project for Udacity's React & Redux course

Employee Polls Project This is the starter code for the final assessment project

May 23, 2022

A starter code to start the project built with Laravel 9 + InertiaJs + ReactJs

A starter code to start the project built with Laravel 9 + InertiaJs + ReactJs

This is a starter code to start the project built with Laravel 9 + InertiaJs + ReactJs, which already includes multiple layout admin templates with login for authentication

May 30, 2022

A clean, beautiful, responsive and 100% customizable portfolio template for Data Scientists!

A clean, beautiful, responsive and 100% customizable portfolio template for Data Scientists!

A portfolio template for datascientists using reactjs

Jun 21, 2022

Salvia-kit provides beautiful dashboard templates built with Tailwind CSS for React, Next.js, Vue and Nuxt.js

Salvia-kit provides beautiful dashboard templates built with Tailwind CSS for React, Next.js, Vue and Nuxt.js

Salvia-kit provides beautiful dashboard templates built with Tailwind CSS for React, Next.js, Vue and Nuxt.js

Jun 12, 2022

โš›๏ธA free and beautiful React admin dashboard template pack.

โš›๏ธA free and beautiful React admin dashboard template pack.

Shards Dashboard React A free React admin dashboard template pack featuring a modern design system and lots of custom templates and components. โœจ Note

Jun 25, 2022

Light Bootstrap Dashboard React is an admin dashboard template designed to be beautiful and simple.

Light Bootstrap Dashboard React is an admin dashboard template designed to be beautiful and simple.

Light Bootstrap Dashboard React Light Bootstrap Dashboard React is an admin dashboard template designed to be beautiful and simple. It is built on top

Jun 20, 2022
Official Documentation and Blog for the Review Bots Website. Made with Love using React, Docusaurus and Typescript
Official Documentation and Blog for the Review Bots Website. Made with Love using React, Docusaurus and Typescript

Official Documentation and Blog for the Review Bots Website. Made with Love using React, Docusaurus and Typescript

Feb 3, 2022
Highly Scalable Awesome React Starter Kit for an enterprise application with a very easy maintainable codebase. :fire:
Highly Scalable Awesome React Starter Kit for an enterprise application with a very easy maintainable codebase. :fire:

React Enterprise Starter Kit ?? Highly Scalable, performant and amazing react boilerplate for react developers to get started and improve web building

Jun 2, 2022
Nextjs-ts-mui5-scss-storybook-starter - Next.js + TypeScript + Material UI v5 + Sass + Storybook starter
Nextjs-ts-mui5-scss-storybook-starter - Next.js + TypeScript + Material UI v5 + Sass + Storybook starter

nextjs-ts-mui5-scss-storybook-starter ?? Next.js + TypeScript + Material UI v5 +

Jun 16, 2022
Nextjs-starter - A TypeScript starter for Next.js

Next.js TypeScript Starter Features โšก๏ธ Next.js 12 โš›๏ธ React 17 โ›‘ TypeScript ?? ES

May 23, 2022
React Package Starter - a simple and slightly opinionated starter kit for developing and publishing React packages

React Package Starter This is a simple and slightly opinionated starter kit for developing and publishing React packages. It comes with a several pre-

Jun 21, 2022
โญ Starter project for React Js. โœ๏ธ Developed by Gentrit Halili.

The project is helpful to start your next project, as it provides a lot of the common tools you may reach for, all ready to go.

May 31, 2022
Starter project for firebase web with React, Chakra UI and auth pages added
Starter project for firebase web with React, Chakra UI and auth pages added

Firebase React Chakra UI Starter A starter project for Firebase web. Installation Clone the repository git clone [email protected]:stephenbaidu/firebase-

Jun 2, 2022
A starter project for React-Three-Fiber bootstrapped with Create-React-App and some useful packages
A starter project for React-Three-Fiber bootstrapped with Create-React-App and some useful packages

A starter project for React-Three-Fiber bootstrapped with Create-React-App and some useful packages

Jan 16, 2022
This project is a React Starter Kit with basic tools and examples of their use.

Welcome React Starter Kit! This project is a React Starter Kit with basic tools and examples of their use. Tools used React: V17 react-hook-form: V7 r

Oct 27, 2021
A starter project for modern React apps with Redux

React + Redux w/ ES6 Starter Project ?? A Completely updated version of my initial boilerplate ?? Note: If you still want to use a previous version, p

Apr 22, 2022