Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode. Open http://localhost:3001 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is ready to be deployed! See the section about deployment for more information.

yarn lint

Checks the codes by eslint, we will lint them before commit automatically.

yarn commit

An optional way to use git cz if you don't want to install commitizen globally.

Modules & Features

Dashboard

Blog Statistics

Create or update an item

Move up / Move down / Move Top

Moves one item's order by weight.

Post list

Post editor

Agenda

Manages your agenda quickly.

Profile

Changes your nikename, region, organization, website, Bio, avatar and so on. The drawer on the left will be updated in real time.

Account

The account module allows you to update username and email or delete your account.

Security

The security module allows you to update password and supports two-factor authentication base on TOTP and SMS verification code. You can also apply and use recovery codes if you cannot use the above two verification methods.

Contributing

The main purpose of this repository is to continue to evolve BEG (Blog Environment Group), making it faster and easier to use. Development of Blog CMS v2 happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Blog CMS v2.

Code of Conduct

BEG has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Blog CMS v2.

Good Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Semantic Commit

This app follows the Angular Team's Commit Message Guidelines, your commit will be checked by commitlint, please use git cz instead of git commit. For this reason, you should install commitizen globally or use yarn commit instead.

Env File

Creates .env.development.local file or other env files to pass environment varibles.

TODOs

• [ ] Support multi-roles management

• [ ] Support forget password

• [ ] Login with 2FA

• [ ] Support notification and full-site search

License

Blog CMS v2 is licensed under the terms of the MIT licensed.