Installation
The page describes the installation process of the Journal de bord single page application.
Last updated
Was this helpful?
The page describes the installation process of the Journal de bord single page application.
Last updated
Was this helpful?
The single-page application requires that two other services are up running:
An instance of the Journal de bord RESTful API: this web service is used by the SPA to handle the users journal de bord resources. You can find its code in this .
An authorization server: this is the authority that secures the users resources. In my case, I have developed the project using an .
In the next section, you can find the required information that you need to provide to the SPA to make it work.
Currently, the application is still in development and it is not integrated with the REST API.
The application relies on multiple environment variables. They are described in the following subsection.
You need need to specify a value for each of the following variables in the .env
file (this file lives at the root of the project).
REACT_APP_AUTH_SERVER_URI
: is the root URI of the authorization server.
REACT_APP_CLIENT_ID
: is the identifier of this web client registered in your authorization server.
REACT_APP_AUTH_SERVER_TOKEN_URI
: is the authorization server endpoint that provide this client with an access token.
REACT_APP_AUTH_SERVER_LOGIN_URI
: is the authorization server endpoint that provide this client with a login page.
REACT_APP_AUTH_SERVER_REGISTER_URI
: is the authorization server endpoint that provide this client with a register page.
.env
fileIn the root of the project you can find the .env.example
. The file is the one referred to in the previous subsection. Here is its content.
To set the variables (as described in the previous section), go to:
Open the site to set the variables for
Go to Site Settings
Go to the Build & Deploy section
Go to Environment
You should find this following screen. There you go 😁! Go ahead and set the required environment variables.
The custom environment variables are set following the .
This web client is published on Netlify. This section focuses on this platform. The configuration is easy. Netlify documentation explains how it is done right .
Netlify explains how to publish on this . Currently, the project is automatically deployed on Netlify when a branch is merged to the master. I still need to configure the environment variables manually.
Go to