From bd8c05cdd218285b216728b18d2b176b39d82b6b Mon Sep 17 00:00:00 2001 From: RoberTu Date: Fri, 31 Jul 2020 11:33:08 +0800 Subject: [PATCH 1/2] chore(release): v3.12.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 6635e79202..8ea219bd62 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "matters-web", - "version": "3.11.0", + "version": "3.12.0", "description": "codebase of Matters' website", "sideEffects": false, "author": "Matters ", From 37dd44d2c89ebb35bf0986ebb61d9c8829c40743 Mon Sep 17 00:00:00 2001 From: RoberTu Date: Fri, 31 Jul 2020 11:45:03 +0800 Subject: [PATCH 2/2] docs(readme): revise README --- README.md | 34 ++-------------------------------- 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 8ad5e08c98..d81378841e 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ - Install dependencies: `npm i` - Environment variables: `cp .env.local.example .env.local` -- (Optional) Run `npm run gen:type` or `npm run gen:watch` +- Run `npm run gen:type` or `npm run gen:watch` - Run `npm run dev`, then go to `http://localhost:3000/` ### Build and run production server `npm run build && npm run start` -### Start local dev with docker +### Start local dev with Docker - Environment variables: `cp .env.local.example .env.local` - Set command alias: `source bin/dc-alias` @@ -44,30 +44,6 @@ - `docker pull 903380195283.dkr.ecr.ap-southeast-1.amazonaws.com/matters-web:latest` - `docker tag 903380195283.dkr.ecr.ap-southeast-1.amazonaws.com/matters-web:latest matters-web:latest` -## Routing - -We customized routes with Express in `server.ts` and disabled [fs routing](https://github.com/zeit/next.js#disabling-file-system-routing). - -Note that we need to specify `href` (the path inside pages directory + query string) and `as` (the path that will be renderer on browser URL bar) props in `` component. - -For instances: - -```jsx -// Home - - -// All Authors - - -// User Comments - - -// Tag Detail - -``` - -See [next.js docs](https://github.com/zeit/next.js#routing) for more details. - ## Conventions [Matters Design System](https://paper.dropbox.com/doc/Matters-Design-System--AXX9x2tuPldQFCWTN0Mt~_itAQ-klFuV5yv3ZlqpqHL0w0kU) @@ -128,12 +104,6 @@ See `.vscode/settings.json` For vim users, you might want to see `.vim/.vimrc` (using vim-plug). -## Release a new version - -1. Update `CHANGELOG.md` -2. Update `version` field of `package.json` -3. Create a new release and tag in [GitHub Releases](https://github.com/thematters/matters-web/releases) - ## Troubleshooting 1. If `styled-jsx` is installed in both `next` and our own `package.json`, the built-in `styled-jsx` SSR of Next.js will fail. See [#533](https://github.com/zeit/styled-jsx/issues/533).