Skip to content

Commit

Permalink
Reformat the README and remove todo list
Browse files Browse the repository at this point in the history
  • Loading branch information
foodelevator committed Jul 30, 2023
1 parent 80c9ee7 commit 45f001f
Showing 1 changed file with 6 additions and 19 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
BAWANG
======
# BAWANG

Universal react application for the chapter website.

Environment variables
-------
## Environment variables

| Name | Default | Description |
|--------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------|
Expand All @@ -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.

0 comments on commit 45f001f

Please sign in to comment.