diff --git a/README.md b/README.md index aa0ecf1..620fb36 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,34 @@ # GohCMS + ## 🚧 This project is under development ! + The features are not complete, not tested and subject to many changes. + ## Setup + ### Use with Docker + To **run** the app, run the command + ```shell docker-compose up ``` ### Build and run it yourself + TODO + ## Environment variables + - ./env - - APP_BASE_API_PATH - - APP_BASE_FRONT_PATH - - APP_API_ADDRESS - - APP_FRONT_ADDRESS - - APP_API_PORT - - APP_FRONT_PORT - - APP_JWT_SECRET + - APP_API_ADDRESS: `http://example.com` + - APP_FRONT_ADDRESS: `http://example.com` + - APP_BASE_API_PATH: `/example` + - APP_BASE_FRONT_PATH: `/example` + - APP_API_PORT: `1234` + - APP_FRONT_PORT: `1234` + - APP_JWT_SECRET: `secret` + ## Demo -TODO \ No newline at end of file + +TODO