Skip to content

dreammall-earth/dreammall.earth

Repository files navigation

Dreammall.earth

nodejs npm remark-cli vuepress

Dreammall.earth websites & services

Modules

Deploy

Deploy instructions can be found in deployment/

Commands

The following commands are available:

Command Description
npm install Project setup
Test
npm run test:lint Run all linters
npm run test:lint:remark Run linter remark
npm test Run all tests & linters
Documentation
npm run docs:dev Run Documentation in development mode
npm run docs:build Build static documentation
Release
npm run release Propagate release version & generate changelog
Maintenance
npm run update Check for updates

Docker

The following endpoints are provided if docker compose is used:

Endpoint Description
http://localhost:3306 MySQL Database
http://localhost:3000 Presenter
http://localhost:8081 Presenter Documentation
http://localhost:6006 Presenter Storybook
http://localhost:3001 Frontend
http://localhost:8082 Frontend Documentation
http://localhost:6007 Frontend Storybook
http://localhost:3002 Admin
http://localhost:8083 Admin Documentation
http://localhost:6008 Admin Storybook
http://localhost:4000/graphql Backend GraphQL API
http://localhost:4000/playground Backend GraphQL Playground
http://localhost:8084 Backend Documentation
http://localhost:8080 Documentation

How to release

Generate a new version using npm version --git-tag-version=false patch|minor|major. Then run npm run release to propagate the new version and generate the changelog

Update

You can get a list of packages to update by running npm run update.

Appending -u will also update the packages in the package.json. You have to run npm install again after.

npm run update -- -u
npm install

External Tools

This project is tested with Browserstack.

License

Apache 2.0