Menu

• Blog BE Next
  • Menu
  • Available Scripts
    • yarn build
    • yarn watch
    • yarn document
    • yarn test
    • yarn commit
  • Contributing
    • Code of Conduct
    • Contributing Guide
    • Good Issues
    • Commitizen
    • Env Files
    • E2E Testing
  • Changelogs
  • TODOs
  • License

Available Scripts

In the project directory, you can run:

yarn build

Builds the app for production to the dist folder. This script will delete the old dist folder before build.

yarn watch

Runs the app in the development mode. Open http://localhost:3002 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 document

Via compodoc to generate an awesome document for this app.

yarn test

Runs Jest via yarn test.

yarn commit

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

⇧ back to top

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 BE Next 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 BE Next.

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 BE Next.

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.

Commitizen

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 Files

Creating production.env, development.env and test.env to save specified environment variables. Common parameters cound be filled in .env. Both DATABASE_USER and DATABASE_PWD are optional parameters in development.env and test.env file. Furthermore, NEED_SIMULATE_NETWORK_THROTTLE is only working on the development environment.

NODE_ENV=<YOUR_NODE_ENV>
APP_PORT=<YOUR_APP_PORT>
DATABASE_HOST=<YOUR_DATABASE_HOST>
DATABASE_PORT=<YOUR_DATABASE_PORT>
DATABASE_COLLECTION=<YOUR_DATABASE_COLLECTION>
# `DATABASE_USER` and `DATABASE_PWD` are optional parameters in
# `development.env` and `test.env` file
DATABASE_USER=<YOUR_DATABASE_USER>
DATABASE_PWD=<YOUR_DATABASE_PWD>
BANDWAGON_SECRET_KEY=<YOUR_BANDWAGON_SECRET_KEY>
BANDWAGON_SERVER_ID=<YOUR_BANDWAGON_SERVER_ID>
IP_STACK_ACCESS_KEY=<YOUR_IP_STACK_ACCESS_KEY>
GOOGLE_RECAPTCHA_KEY=<YOUR_GOOGLE_RECAPTCHA_KEY>
JWT_SECRET_KEY=<YOUR_JWT_SECRET_KEY>
JWT_EXPIRES_TIME=<YOUR_JWT_EXPIRES_TIME>
# Only works on the development environment.
NEED_SIMULATE_NETWORK_THROTTLE=<BOOLEAN>

E2E Testing

We use e2e testing for every module and test them at CI stage, you must write related test cases before PR.

⇧ back to top

Changelogs

The following are prehistoric changelogs on building infrastructure for this app. Just as a memorial. See the real detailed changes for each release are documented in the CHANGELOG.

• 2019-12-03 Integrates e2e testing.

• 2019-11-26 Integrates JWT.

• 2019-11-07 Integrates dotenv.

• 2019-11-04 Integrates GraphQL.

• 2019-10-20 Integrates MongoDB and write the first RESTful CRUD.

• 2019-10-12 Initital repo.

⇧ back to top

TODOs

• ~~[ ] Full text search for post (We are using Algolia Search)~~

• [ ] Fine-grained type verification system optimization

• [ ] Supports forget password

• [ ] Supports role-based permission system

• [ ] Supports two factor authentication (Both of TOTP and SMS)

• [ ] Dockerize

⇧ back to top

License

Blog BE Next is under the MIT licensed. See the LICENSE file for the full license text.