mirror of
https://github.com/usatiuk/ustk-todolist.git
synced 2025-10-29 08:07:48 +01:00
update readme
This commit is contained in:
16
README.md
16
README.md
@@ -3,30 +3,32 @@
|
||||
This is a simple todo list, written in javascript, using express for the backend and react/redux for the frontend.
|
||||
It also can work in offline, thanks to redux-offline.
|
||||
|
||||
## Running it
|
||||
## Getting started
|
||||
|
||||
To run it you should start the backend and the frontend.
|
||||
To start the backend use `npm run debug`
|
||||
To start the frontend `cd react && npm start`
|
||||
You can do it with `npm run dev`
|
||||
|
||||
And visit it at http://localhost:3000
|
||||
create-react-app proxy will be listening at http://localhost:3000.
|
||||
|
||||
## Configuration
|
||||
|
||||
By default development server uses mongodb todolist database at localhost, you can change it with environment variable `DB_URI`
|
||||
By default development server uses mongodb `todolist` database at localhost, you can change it with environment variable `DB_URI`
|
||||
|
||||
If you are running it in production environment, you should set these environment variables:
|
||||
|
||||
```
|
||||
HSTS = true/false
|
||||
MONGODB_URI
|
||||
DB_URI (or MONGODB_URI)
|
||||
PORT
|
||||
SECRET
|
||||
HOST
|
||||
```
|
||||
|
||||
There is google OAuth support, which can be enabled by setting `GOOGLE_ENABLED` variable to true, however for it to actually work you must also set `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`
|
||||
|
||||
## Offline
|
||||
|
||||
To enable service worker, the frontend should be run in production environment.
|
||||
To run it locally you should build the frontend: `cd react && npm run build`.
|
||||
|
||||
And visit it at http://localhost:4000
|
||||
Express is listening at http://localhost:4000 and serving the built frontend.
|
||||
|
||||
Reference in New Issue
Block a user