From 45f001fb3b8dfff10a7d0604d8b750d9b4756d48 Mon Sep 17 00:00:00 2001 From: Mathias Magnusson Date: Sun, 30 Jul 2023 16:13:00 +0200 Subject: [PATCH] Reformat the README and remove todo list --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3ebcd38..99b4502 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ -BAWANG -====== +# BAWANG Universal react application for the chapter website. -Environment variables -------- +## Environment variables | Name | Default | Description | |--------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------| @@ -13,20 +11,9 @@ Environment variables | RAZZLE_CALYPSO_URL | https://calypso.datasektionen.se/api | URL to get news from calypso on. **Set during build** | | PORT | 3000 | Port to listen on | -Running -------- +## Running Bawang runs on Node v.10.x.x. It doesn't work on later versions (v.12.20.1) -`npm start:dev` will start the whole universal server in development mode. HMR will be enabled on both server and client side! - -`npm run build` will build a production ready server. - -`npm run start` will start the production server. - -TODO ----- -- Fix frontpage styling -- Feature complete news page -- Improve translation implementation -- Add more content providers, i.e. skywhale, pandora -- Write a more helpful README +- `npm start:dev` will start the whole universal server in development mode. HMR will be enabled on both server and client side! +- `npm run build` will build a production ready server. +- `npm start` will start the production server.