By Luka Cerrutti.
The
.envfiles are not versioned inside this repository.
Inside both projects, api and client, there are .env.example files: From this base, we copy their content inside a new .env file in the same directory of the example.
We must then have two new non-versioned files at api/.env and client/.env.
Only software requirement is a containerization technology compatible with docker-compose files (like Docker or Podman). As explained before, environment files must be all set-up.
docker-compose up
From here, we can work with the generated network & containers as any other multi-containerized application. For Docker and Compose users, see the official compose docs.
API documentation can be found navigating
/docsAPI route.
Categories are used to group news.
Navigate to the /admin frontend route (assuming local-hosting on port 3000, would be http://localhost:3000/admin). The panel's password is whatever string set as ADMIN_PASSWORD of the backend's .env file (as in the example, 123456).
Navigating to the root of the application, we can subscribe an email to one or more categories. The recipient will recive exclusively news that have this category assigned.
Going back to the admin's panel as we did in step 1, and scrolling all the way to the bottom upon the last section, we can intuitively send and/or schedule a new.
Since no SMTP server access was provided, the application uses WPOven's free SMTP server for testing.
Inside the WPOven's page (https://www.wpoven.com/tools/free-smtp-server-for-testing), enter the email that we subscribed on step 2 and click Access Inbox.
In mail's footer there is an unsubscribe anchor link that redirects to the frontend /unsubscribe route, where we can update our subscription; either removing certain or all categories.