Alpha Site
This is a Next.js project bootstrapped with create-next-app
.
Getting Started
You can run the development server directly or through docker-compose:
npm i
npm run dev
# or
docker-compose run dev
Open http://localhost:3000 with your browser to see the result.
Enabling Report a Problem
- First create a GC Notify Account
- Once you have your account created ask to be added to the Alpha Site account
- Set the following environment variables (definitions below )
REPORT_A_PROBLEM_ENABLED
,NOTIFY_REPORT_A_PROBLEM_TEMPLATE_ID
,NOTIFY_REPORT_A_PROBLEM_EMAIL
,NOTIFY_API_KEY
,NOTIFY_BASE_API_URL
- Start application as usual
Enabling User Signup
- First create a GC Notify Account
- Once you have your account created ask to be added to the Alpha Site account
- Run mongo container and mongo express using docker
docker compose up mongodb mongo-express -d
- Set the following environment variables (definitions below)
MONGO_URL
,MONGO_DB
,USER_SIGNUP_ENABLED
,USER_SIGNUP_FRENCH_TEMPLATE_ID
,USER_SIGNUP_ENGLISH_TEMPLATE_ID
- Start the application as usual
Environment Variables
Here is a list of all the environment variables used to configure the application along with what they do.
MONGO_URL
: The URL for the MongoDB. If you are using the compose set up locally this is `mongodb://root:example@localhost:27017
MONGO_DB
: The database or namespace to use ( will automatically be created if it doesn't exist )
REPORT_A_PROBLEM_ENABLED
: Feature flag for the report a problem API to enable sending to GC Notify. Leave undefined if you do not want to enable this.
USER_SIGNUP_ENABLED
: Feature flag for the user sign up API. Leave this undefined if you do not want to enable this. The route will automatically return a 200 in this case
USER_SIGNUP_FRENCH_TEMPLATE_ID
: The French template to use for user sign up
USER_SIGNUP_ENGLISH_TEMPLATE_ID
: The English template to use for the user sign up
NEXT_PUBLIC_NOTIFY_REPORT_A_PROBLEM_TEMPLATE_ID
: The Notify template ID for the report a problem email template
NOTIFY_REPORT_A_PROBLEM_EMAIL
: The email to send it too
NOTIFY_API_KEY
: The Notify API key
NOTIFY_BASE_API_URL
: The base url for the Notify api. This value should be https://api.notification.canada.ca
NEXT_PUBLIC_API_MOCKING
: Value can be enabled
or disabled
. If enabled, a mock service worker will run in the Node environment to intercept handled network requests in NextJS data fetching methods like getStaticProps(). We use this to mock API responses during Cypress testing.
STRAPI_API_BACKEND_URL
: Root URL for the Strapi CMS API. We use https://alphasite-api.dts-stn.com/ for our application.
NEXT_PUBLIC_ADOBE_ANALYTICS_URL
: URL for adobe analytics. It is found in the documentation for Adobe Analytics installation.
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Vercel
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.