The tsrouter-client module [tell us what this module does and why, what problem does it solve].
tsrouter-client is based on the microservice Chassis framework and
the Frontend Foundation Server library. For more information about the
Chassis and its available commands, please consult the Chassis
documentation. For information on configuring fef-server
to your specific
needs see the README.
Local Development Instructions
This project comes with Dev Container configuration, so you can pull the project's repository and start it locally by running:
orm dev start tsrouter_client
Once your terminal session is connected to the Dev Container, you can do the following to start the project:
orm dev run
To lint the project's code or run the test suite, you can use:
orm dev lint
orm dev test
Your service will be available on port ``, and you can reach it
by making requests to http://localhost:. The project is also
has the configuration needed by Local Platform, so is accessible through
the .oreilly.local
domains as well.
For information on other commands available in this project, you can examine the
scripts
found in the package.json
. For a complete list of commands available
from the orm
CLI, you can run:
orm dev run --list
Familiarize yourself with the functionality fef-server provides and decide if you need to customize any of it.
Replace the Home
component in src/client/components/Home/
with the main
component of your application.
Add more routes to the App
component in src/client/components/App/
if
desired.
To prepare your application for deploy, make any needed changes in
application.json
for your specific application/team, then run
/orm/manage.py preflight
This will perform the steps necessary to make your application deployable. One of the actions in this step is to create Jenkins jobs that are responsible for the deploying of your application. You can learn more about those jobs here.