Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.03 KB

README.md

File metadata and controls

55 lines (34 loc) · 2.03 KB
Raw

Aotearoa Airborne Pollen Collective (AAPC) - Frontend

TypeScript Next JS TailwindCSS

Our frontend app will utilize Next.js' powerful server-side rendering features to supercharge the user experience, as well as TailwindCSS's unique approach to styling to provide an efficient, and aesthetically pleasing website.

Starting the Local Server

Make sure your working directory is in the frontend root directory.

cd frontend

Install Dependencies

Install dependencies using npm:

npm i

Starting the Development Server

npm run dev

The default port is configured to 3001. The environment is LOCAL by default.

Open http://localhost:3001 with your browser to access the website.

Deployment Rules

  • Any changes pushed to GitHub on any branch will be deployed to Vercel Development Preview. This is not public.
  • Any changes pushed on the dev branch will be deployed to the development environment (https://dev.aapc-nz.org).
  • Any changes pushed on the main branch will be deployed to the production environment (https://www.aapc-nz.org).

Environments

LOCAL

When running the frontend locally, the ENV will be LOCAL, and the backend endpoint URI will be configured to http://localhost:3000.

DEV

On https://dev.aapc-nz.org (the development environment), the ENV will be DEV, and the backend endpoint URI will be configured to https://dev-api.aapc-nz.org.

PROD

On https://www.aapc-nz.org (the production environment), the ENV will be PROD, and the backend endpoint URI will be configured to https://api.aapc-nz.org.