diff --git a/docs/components/BannerText.jsx b/docs/components/BannerText.jsx index 3b701c9c..70df2ff6 100644 --- a/docs/components/BannerText.jsx +++ b/docs/components/BannerText.jsx @@ -1,9 +1,10 @@ function BannerText () { const version = process.env.RELEASE_VERSION ?? '0.0.0' + const repository = 'acap-v2' return ( - 🎉 {version}, dev branch @{process.env.COMMIT_ID ?? '123456'} is released. Read more → + 🎉 {repository} - {version}, dev branch @{process.env.COMMIT_ID ?? '123456'} is released. Read more → ) } diff --git a/docs/pages/articles/_meta.json b/docs/pages/articles/_meta.json index 63fdd183..2bdc20fd 100644 --- a/docs/pages/articles/_meta.json +++ b/docs/pages/articles/_meta.json @@ -1,4 +1,6 @@ { "deployment": "Deployment", - "pdf-development": "PDF Development" + "pdf-development": "PDF Development", + "provinces-municipalities": "Provinces and Municipalities", + "opensource-libraries": "Open Source Libraries" } diff --git a/docs/pages/articles/opensource-libraries.mdx b/docs/pages/articles/opensource-libraries.mdx new file mode 100644 index 00000000..8051ea6d --- /dev/null +++ b/docs/pages/articles/opensource-libraries.mdx @@ -0,0 +1,25 @@ +import { Callout } from 'nextra/components' + +# Use of Open Source Libraries and Frameworks + +## Mainstream Libraries + +The ACAP, a web application built with React (NextJS), Node, and Firebase, uses mainstream, community-driven open source, well-tested, and documented Node libraries and frameworks, including but not limited to [React](https://www.npmjs.com/package/react)/[NextJS](https://nextjs.org/), [ExpressJS](https://www.npmjs.com/package/express/), [Firebase](https://www.npmjs.com/package/firebase), [Leaflet](https://www.npmjs.com/package/react-leaflet), [Axios](https://www.npmjs.com/package/axios), and lots more. + +A comprehensive list of these libraries and their versions used within the project are available in the [client](/directories/client) and [server](/directories/server) `package.json` files of the ACAP project. + +## Other Libraries + +Besides using mainstream libraries, ACAP also uses **two (2)** newer, well-tested, and documented open-source libraries to efficiently manage specific low-impact requirements in a focused and easily extendable manner, set apart from ACAP's growing collection of internal libraries and scripts. These libraries used the open-source model to enhance collaboration and foster community contributions, ensuring that ACAP can optionally benefit from ongoing improvements and feedback, with coordination with future ACAP Maintainers. + +> These libraries encourage community contributions and feedback, with their main Maintainer overseeing the development process to ensure that all updates and contributions align with the project's goals and standards. Community input is valued and considered, but final decisions regarding updates will rest with the Maintainer. + +**One of these libraries**, in particular, has goals of enhancing and thoroughly testing possible [Regional Provinces / Municipalities Inconsistency](/articles/provinces-municipalities/#regional-provinces--municipalities-inconsistency) by offering tailored functionality and methods that will automatically sync PAGASA 10-day region/province/municipality names with PSGC data, resulting in less maintenance (customization) burden which is already beyond the original ACAP project timeline, project scope, and deliverables. _This initiative is essential to enhance the accuracy and reliability of the data used in the ACAP project, which is crucial for its functionality._ + +> Since library updates and enhancements may extend beyond the ACAP project timeline, future ACAP Maintainers and developers can choose whether to adopt its updates, continue using the current version, or adopt entirely new solutions. + +These libraries, designed for compatibility and easy extension, follow semantic versioning. Their codes and logic, following safety and security practices, are available for inspection in the public NPM registry. + + +For more information about these open-source libraries and their goals and motivations within the ACAP project, kindly contact the ACAP Maintainers. + diff --git a/docs/pages/articles/provinces-municipalities.mdx b/docs/pages/articles/provinces-municipalities.mdx new file mode 100644 index 00000000..e3c4521e --- /dev/null +++ b/docs/pages/articles/provinces-municipalities.mdx @@ -0,0 +1,153 @@ +import { Callout, FileTree, Steps } from 'nextra/components' + +export function FAQBox({ title, children, open=false }) { + return ( +
+ + {title} + +
{children}
+
+ ) +} + +# Provinces and Municipalities + +## Data Source + +ACAP uses a combination of the [PAGASA 10-day weather forecast Excel files](https://www.pagasa.dost.gov.ph/climate/climate-prediction/10-day-climate-forecast) and the [PAGASA Seasonal Forecast- Rainfall Analysis Table](https://www.pagasa.dost.gov.ph/climate/climate-prediction/seasonal-forecast) as a data source for its region, provinces, and municipalities list. + +## FAQs + + +ACAP uses the provinces and municipalities list defined in the [PAGASA 10-day weather forecast Excel files](https://www.pagasa.dost.gov.ph/climate/climate-prediction/10-day-climate-forecast), initializing or updating its internal list (per region) after running the `npm run cron:tenday` NPM script. + + + +ACAP uses the region-province grouping from the [PAGASA Seasonal Forecast](https://www.pagasa.dost.gov.ph/climate/climate-prediction/seasonal-forecast) - Rainfall Analysis Table to determine which provinces belong to a region as a reference since it also processes provincial seasonal weather forecast information from the PAGASA Seasonal Forecast. ACAP expects province naming from the two (2) data sources (PAGASA 10-day and Seasonal weather forecasts) to match since both are data products produced by PAGASA. + +ACAP initializes its province list during the [Server Setup](/installation/server-setup/#initialize-provinces-and-municipalities) stage. + + + +No. After more recent tests, it came to light that some province names defined in the PAGASA Seasonal Forecast (Rainfall Table) may not always match the province names defined in the PAGASA 10-day Excel files. + +For example, as of _September 17, 2024_, the `"Davao Occidental"` province is present in the PAGASA Seasonal Forecast (Rainfall Table) under **Region XI (Davao Region)**. However, it is missing in the PAGASA 10-Day Excel files. + +Similarly, the `"Shariff Kabunsuan"` province is available in the PAGASA 10-Day Excel files, but it is nowhere to be found in the PAGASA Seasonal Forecast (Rainfall Table). + +Refer to the [Regional Provinces / Municipalities Inconsistency](#regional-provinces--municipalities-inconsistency) section for more information about possible causes of region/province/municipality naming inconsistencies. + + + + +ACAP does not yet support syncing drastic national geopolitical or administrative divisions updates within the PAGSA 10-day weather forecast Excel files since it aims to use and display raw, un-altered 10-day weather forecast data "as-is" from PAGASA, including provinces and municipality names. + + +However, there are ways to update or change the region in which a province belongs, _**provided its name is present**_ in the PAGASA 10-day Excel file. Refer to the [Updating Regional Provinces](#updating-regional-provinces) section to know more about this method. + + + +Drastic updates to the region/province/municipalities naming convention or regional/provincial grouping that will thoroughly transform the original PAGASA 10-day weather forecast Excel file contents will require customization of forked ACAP **backend** or **frontend** codes and **NPM scripts** that facilitate 10-day weather forecast updating and seasonal weather forecast uploading to accommodate custom naming or grouping needs. + +Refer to the [Intensive Province/Municipalities Customizations](#intensive-provincemunicipalities-customizations) section for more information about this approach. + + + + +It is not yet thoroughly tested if the regional province lists generated by ACAP's `npm run pagasa:municipalities` script are updated (synced with the latest [PSCG](https://psa.gov.ph/classification/psgc) administrative divisions) for ALL regions, except Region 5. + +The `pagasa:municipalities` NPM script, which uses the [ph-municipalities](https://www.npmjs.com/package/ph-municipalities) library's **`npm run list:region`** CLI script under the hood uses a static-defined region-to-province [mapping file](https://github.com/ciatph/ph-municipalities/blob/dev/app/config/regions.json) updated on 2024 regarding the available [PAGASA Seasonal Forecast- Rainfall Analysis Table](https://www.pagasa.dost.gov.ph/climate/climate-prediction/seasonal-forecast). + + +It is also subject to possible outdated region/province/municipality naming content mentioned in the [Regional Provinces / Municipalities Inconsistency](#regional-provinces--municipalities-inconsistency) section. + + +Refer to the [Updating Regional Provinces](#updating-regional-provinces) section for more troubleshooting information if this script generates regional province lists with missing or extra provinces. + + + +Sometimes, ACAP users or developers may notice several greyed out (disabled) municipalities listed from the dropdown menus in the Cropping Calendar, 10-day weather forecast, or crop recommendations pages. + +Inconsistent (or missing) municipality names between cropping calendars and the PAGASA 10-day weather forecast, which ACAP considers its "official" source of provinces and municipality listing, often causes municipalities to be disabled or greyed out. + + +ACAP tracks inconsistent-named municipalities between these two (2) sources to promote consistent municipality naming conventions on every successful upload of cropping calendars or run of the `npm run cron:tenday` script, flagging those which it finds inconsistent. + +Since ACAP officially uses the PAGASA 10-day weather forecast municipality names, it will not find missing (or misspelled) municipality names in the cropping calendar when determining a selected municipality's crop stage(s) during recommendations generation. + + +To enable the greyed-out municipalities, upload cropping calendars that follow the PAGASA 10-day weather forecast municipality names and [cropping calendar Excel format](/post-installation/cropping-calendar/calendar-v2/#data-format). Inconsistent-named municipalities are available for viewing in the development and production **Firestore document** for reference: + +```bash copy +/constant_data/diffs +``` + + +## Regional Provinces / Municipalities Inconsistency + +While ACAP Bicol (Region 5) or other regions generally may sync well with its provinces and municipalities listed from the PAGASA 10-day weather forecast Excel data source, several factors may affect its consistency in the long run. + +- Updates in the Philippine geopolitical or administrative divisions in the future (usually mandated by the [Philippine Standard Geographic Code](https://psa.gov.ph/classification/psgc) (PSGC)) may take some time to reflect on the contents and naming convention within the PAGASA 10-day weather forecast Excel files or Seasonal Forecast - Rainfall Analysis Table. + +- It is not yet thoroughly tested if ALL regions, provinces, and municipality names from PAGASA's 10-day weather forecast Excel files (`provinces and municipalities`) and their Seasonal Weather Forecast - Rainfall Analysis table (`regions and provinces`) are up to date with the latest Philippine administrative divisions. + +## Updating Regional Provinces + +This simple region-province grouping method assigns the PAGASA 10-day Excel files' provinces (and their associated municipalities) to a region without transforming or altering the original province/municipalities naming contents of the 10-day Excel files. + + +It requires target province(s) defined in the PAGASA 10-day Excel file to work. + + + + +### Confirm target provinces + +1. Download and open a PAGASA 10-day weather forecast Excel file from the [PAGASA 10-Day Climate Forecast web page](https://www.pagasa.dost.gov.ph/climate/climate-prediction/10-day-climate-forecast). + +2. Find the province(s) in the downloaded Excel file to add to your region. + - These province(s) may belong to other regions generated by the `npm run pagasa:municipalities` script, or they may be missing from the list but exist in the 10-day Excel files. + +### Add province to a region + +Add new provinces(s) to a region's list of provinces from province names confirmed on **step #1**. For example to add the `"Isabela"` province to ACAP Bicol's list of provinces, add `"Isabela"` to the server's `PROVINCES` variable in the `.env` file. + +```env copy +PROVINCES=Albay,Camarines Norte,Camarines Sur,Catanduanes,Masbate,Sorsogon,Isabela +PROVINCES_ARCHIVE... +``` + +### Remove a province + +Similarly to remove a province from a region, remove its text string from the `PROVINCES` (or `PROVINCES_ARCHIVE`) server environment variables. + +### Sync new provinces + +Run the script after [adding](#add-province-to-a-region) or [removing](#remove-a-province) a province from a region to update ACAP's list of provinces and municipalities. + +```bash copy +npm run cron:tenday +``` + + +## Intensive Province/Municipalities Customizations + +For **intensive naming and grouping transformation** beyond the simple method covered in the [Updating Regional Provinces](#updating-regional-provinces) section, developers can start checking the `/server/src/scripts/cron/update_tenday_weather` **"group" of scripts**, possibly extending and overriding its **`/classes/exceladapter/index.js`** class. This class [_extends_](https://javascript.info/class-inheritance#the-extends-keyword) the **ph-municipalities** library's `ExcelFile` class for managing the PAGASA 10-day Excel provinces/municipality lists. + +The `ExcelFile` class has available [class methods, functions, and constructors](https://ciatph.github.io/ph-municipalities/ExcelFile.html) dedicated and tested to parsing provinces/municipality lists from a PAGASA 10-day weather forecast Excel file, which developers can [_override_](https://javascript.info/class-inheritance#overriding-a-method) and [_extend_](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/extends) within ACAP's existing class scripts to customize region/province/municipality grouping and naming processing. + +Some parts of the **front end** may also need updating depending on the level of customization required. + + +This method will _alter_ the original (province and municipalities) naming convention of a PAGASA 10-day weather forecast Excel file. Consult and deliberate first if this is a requirement before proceeding. + +Indicate notices and messages in the public ACAP front end about these changes to the PAGASA 10-day provinces and municipalities naming and grouping for transparency. + + +## References + +- This page is related to the [Server Setup - Initialize provinces and municipalities](/installation/server-setup/#initialize-provinces-and-municipalities) section. \ No newline at end of file diff --git a/docs/pages/changelog.mdx b/docs/pages/changelog.mdx index aacd6036..80f3c4c3 100644 --- a/docs/pages/changelog.mdx +++ b/docs/pages/changelog.mdx @@ -42,15 +42,15 @@ Version 2.0 and later versions may have new requirements that will thrive on new 6. Optional search engine optimization [(SEO) settings](/post-installation/google-search) with Google Search Console 7. REST APIs (NodeJS) - New endpoints for processing cropping calendar and recommendations Excel file uploads - - Migration of the ACAP-RCMAS APIs from the (forked) mirror environment with optional activation + - Migration of the [ACAP-RCMAS REST APIs](/post-installation/acap-rcmas-api) from the (forked) mirror environment with optional activation and deployment #### Changed 1. Public/admin seasonal recommendations and bulletin PDF generation - - Removal of the month trigger for determining the crop stage/s + - Removal of the single-month selection trigger for determining the crop stage/s - Removal of the rainfall condition trigger 2. Public/admin 10-day recommendations and bulletin PDF generation - - Removal of the dates trigger for determining the crop stage/s + - Removal of the dates trigger within the active PAGASA 10-day date range for determining the crop stage/s 3. Deprecation of the **uploaders** group of Node Package Manager (NPM) scripts in favor of cropping calendar/recommendations Excel file upload through the UI 4. Allow creating seasonal bulletin PDFs with more than one (1) page. 5. Text blast recipients by province/municipality instead of individual selection diff --git a/docs/pages/directories/client.mdx b/docs/pages/directories/client.mdx index 8dc4e887..f359514f 100644 --- a/docs/pages/directories/client.mdx +++ b/docs/pages/directories/client.mdx @@ -2,9 +2,9 @@ import { FileTree, Callout } from 'nextra/components' # Client -The **client** directory contains codes and configurations/settings for the (React) NextJS frontend and Firebase. The folder tree displays the relevant files and folders. +The **client** directory contains codes and configurations/settings for the (React) NextJS front end and Firebase. The folder tree displays the relevant files and folders. -The NextJS frontend uses the **pages router**, since this is suitable for generating static pages to host on GitHub Pages. It uses the `"container-component"` as a dominant pattern, distinguising between logic (container) and UI (component). +The NextJS frontend uses the [**pages router**](https://nextjs.org/docs/pages) since this is suitable for generating static pages to host on GitHub Pages. It uses the `"container component"` as a dominant pattern, also known as `"component and presentational"` components, for distinguishing between logic (container) and UI (component). This documentation only contains information about relevant files and directories within the **client** directory. For more information about NextJS-specific files and configurations (such as the `next.config.js`, `_app.js`, or `document.js` files), please head over to the [NextJS documentation](https://nextjs.org/docs/pages/building-your-application/routing) for **Pages Router**. @@ -22,12 +22,13 @@ Developers should take care not to "bake" or "build" sensitive data and informat - **firestore.rules** - Firestore Rules definitions to publish in a Firebase project's Firestore Rules settings - **storage.rules** - Firebase Storage Rules definitions to publish in a Firebase project's Storage settings - **Dockerfile.acap** - multi-stage build Dockerfile definition for running the client on localhost development or as "built" static files for production deployment running on nginx. +- **package.json / package-lock.json** - Contains definitions of the client's NodeJS dependency libraries ## Folders ### /pages -- Components here serves as the "container" components in the container-component pattern, mmostly component logic +- Components here serves as the "container" components in the container-component pattern, mostly component logic - ex: "pages/admin", "pages/admin/reports", "pages/bulletins", "pages/home" @@ -86,9 +87,7 @@ components/bulletins", "components/home" - - - + @@ -99,14 +98,14 @@ components/bulletins", "components/home" - - - + + + \ No newline at end of file diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index a3683d1e..4fdef7c6 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -1,13 +1,27 @@ +import { Callout } from 'nextra/components' + # Welcome to ACAP Tutorials This site offers a more organized and structured approach to documenting the software development approaches for the Agro-Climatic Advisory Portal - Bicol (ACAP Bicol), initially released as [ACAP 1.0](/changelog/#version-1-acap-10) at the end of 2022 and now enhanced to version [2.0](https://acap-bicol.github.io/) as of 2024. +> The Agro-Climatic Advisory Portal (ACAP), a Climate Information Services web application (CIS) co-developed by the [University of the Philippines Los Banos Foundation, Inc.](https://uplbfi.org/) (UPLBFI) and the [Alliance of Bioversity International and CIAT (Alliance)](https://alliancebioversityciat.org/) with the [Department of Agriculture (DA)](https://www.da.gov.ph/) and the [Regional Field Office 5 (RFO 5)](https://bicol.da.gov.ph/) is a digital platform that serves as a centralized hub for the development of Climate Information Services (CIS) in the Bicol Region. It contains relevant weather and climate information to use with tailored advisories and crop recommendations. + This documentation website is a revamped version of the previous documentation websites, offering informative new sections such as [Post-Installation](/post-installation), containing after-initial installation notes and checklists, more details on [Security](/security) guidelines, and other development-related details. + +The shared private ACAP code repositories, including all [raw source codes, files, and documents](/directories) otherwise stated, are proprietary property of the **Department of Agriculture (DA)** and the **DA Regional Field Office 5**. As such, kindly protect confidentiality, ensuring shared copies obtained after gaining access to the parent repository or private copies/forks from the code Maintainers remain _**private**_ in GitHub or any other public platform. + + ### Previous Tutorials Websites **ACAP 2.0** (latest ACAP Bicol)
https://acaptutorials.github.io/assets-cms/posts/post/?id=cFgd8nBjkdZ6gNNkktGE **ACAP 1.0**
-https://acaptutorials.github.io/assets-cms/posts/post/?id=Teo2m6os7LZtsEi0nGWw \ No newline at end of file +https://acaptutorials.github.io/assets-cms/posts/post/?id=Teo2m6os7LZtsEi0nGWw + +## Content Updates + +The ACAP Development website contents are a continuous work in progress. + +Given time and availability, code Maintainers (old and new) with access to the parent ACAP code repositories and are acquainted with its latest developments and updates will try to update this documentation website as frequently as possible to sync with the latest updates in the codebase. \ No newline at end of file diff --git a/docs/pages/installation/server-setup.mdx b/docs/pages/installation/server-setup.mdx index 75f765be..e4d5009d 100644 --- a/docs/pages/installation/server-setup.mdx +++ b/docs/pages/installation/server-setup.mdx @@ -60,6 +60,14 @@ Run ACAP's `"pagasa:municipalities"` NPM script to get a list of the latest PAG 3. Replace the `PROVINCES` and `PROVINCES_ARCHIVE` variables with the comma-separated province names of your new target region resulting from **step #2**. 4. Replace the `DEFAULT_PROVINCE` .env variable with any province name from the `PROVINCES` comma-separated province names. + +The `"pagasa:municipalities"` NPM script may generate an outdated or incorrect list of provinces of a region depending on several factors. + +- Visit the [Provinces and Municipalities FAQs](/articles/provinces-municipalities/#faqs) or the [Regional Provinces / Municipalities Inconsistency](/articles/provinces-municipalities/#regional-provinces--municipalities-inconsistency) sections for more information on why this may happen. + +- Refer to the [Updating Regional Provinces](/articles/provinces-municipalities/#updating-regional-provinces) guide for possible troubleshooting methods if you notice missing provinces or municipalities after running this script. + + ### Create new superadmin password 1. Open the the file: `/server/src/scripts/seeders/00_superadmin/index.js` @@ -92,6 +100,12 @@ Run this server NPM script to fetch and upload the @latest PAGASA 10-day weather npm run cron:tenday ``` + +This script may fail to fetch and parse 10-day weather forecast data of several municipalities linked with _**provinces not available**_ in the 10-day Excel file. + +Visit the [Provinces and Municipalities](/articles/provinces-municipalities) article for more information if you notice missing 10-day weather forecast data for several provinces and municipalities. + + ### Build the API docs (Optional) (Optional) Build ACAP server's REST API documentation website for reference. diff --git a/docs/pages/post-installation.mdx b/docs/pages/post-installation.mdx index 9f4599e5..6f4e08a7 100644 --- a/docs/pages/post-installation.mdx +++ b/docs/pages/post-installation.mdx @@ -20,6 +20,7 @@ These tutorials contain additional post-installation instructions after initiall ### Others + diff --git a/docs/pages/post-installation/_meta.json b/docs/pages/post-installation/_meta.json index b1252717..bb1af904 100644 --- a/docs/pages/post-installation/_meta.json +++ b/docs/pages/post-installation/_meta.json @@ -6,5 +6,6 @@ "recommendations": "Recommendations Dataset", "acap-rcmas-api": "ACAP-RCMAS REST APIs", "opengraph": "Opengraph Settings", - "google-search": "Google Search Console" -} \ No newline at end of file + "google-search": "Google Search Console", + "province-codes": "Province Codes" +} diff --git a/docs/pages/post-installation/province-codes.mdx b/docs/pages/post-installation/province-codes.mdx new file mode 100644 index 00000000..138a7645 --- /dev/null +++ b/docs/pages/post-installation/province-codes.mdx @@ -0,0 +1,61 @@ +import { Callout, FileTree, Steps } from 'nextra/components' + +# Province Codes + +Province codes refer to the three-letter or two-letter shortcodes abbreviation for a province. For exampe Region 5 Bicol has: + +| Province | Code | +| --- | --- | +| Albay | ALB | +| Camarines Norte | CN | +| Camarines Sur | CS | +| Catanduanes | CAT | +| Masbate | MAS | +| Sorsogon | SOR | + +## Default Values + +The seeder scripts assigns the first three letter of a provice for its short code during the [Installation - Seed default data](/installation/server-setup/#seed-default-data) step. + +## Update the Default Values + +These steps are optional if there is a need to change the default-generated province shortcodes. Follow the steps to update the provinces' default three-letter short code. + + +These steps require a successful run of the [Initialization](/initialization) steps before proceeding. + + + + +### Edit the codes JSON file + +Open the `/server/src/scripts/uploaders/province_codes/data.json` file. + + + + + + + + + + + + + + + +1. Replace the JSON keys with new `"province names"` matching those entered in the server `.env` file. +2. Replace the `"code"` JSON key values with new two or three-letter province shortcodes. +3. Update the `"full"` JSON key values with new `"province names."` + +### Upload the new province shortcodes + +1. Navigate to the server directory using a terminal. +2. Run this command switching between the **development** and **production** `.env` files. + +```bash copy +npm run upload:province_codes +``` + + diff --git a/docs/pages/post-installation/weather-forecasts/seasonal-forecast.mdx b/docs/pages/post-installation/weather-forecasts/seasonal-forecast.mdx index 7445fa63..26d3f83c 100644 --- a/docs/pages/post-installation/weather-forecasts/seasonal-forecast.mdx +++ b/docs/pages/post-installation/weather-forecasts/seasonal-forecast.mdx @@ -43,6 +43,10 @@ Obtain the latest PAGASA seasonal weather forecast Excel file. Developers (or Admins) can use the default seasonal weather forecast Excel file described in the [PAGASA Seasonal Weather Forecast Excel File](#pagasa-seasonal-weather-forecast-excel-file), using values for their respective region, if the PAGASA-shared seasonal weather forecast Excel file is not readily available. + +When editing the sample PAGASA Seasonal Excel file, note to supply `nda` text for cells that have no values. + + ### Upload the Seasonal Weather Forecast Excel File 1. Sign in as an ACAP Admin, then go to the **ACAP Settings** → **SEASONAL** tab. This page is accessible in the localhost route: diff --git a/docs/pages/requirements.mdx b/docs/pages/requirements.mdx index 8e4492b2..a5ee5d59 100644 --- a/docs/pages/requirements.mdx +++ b/docs/pages/requirements.mdx @@ -11,6 +11,8 @@ This post describes the dependencies and requirements needed to run run ACAP 1.0 ### Software Installed +#### Main Development + 1. Visual Studio Code (VSCode) IDE - version: v1.79.2 (any version that can run NodeJS) 2. nvm @@ -26,12 +28,16 @@ This post describes the dependencies and requirements needed to run run ACAP 1.0 - _(preferrably installed using **nvm**)_ - node version: 16.14.2 - npm version: 8.5.0 -3. Yarn version 1.22.19 - - (installed using npm) -4. Git Terminal +3. Git Terminal - For Windows OS: GitBash - For non-Windows OS: (Please refer to the recommended git terminal installation methods for your OS) +#### Bulletin PDF Development + +1. [Yarn](https://yarnpkg.com/) + - **Note:** the project uses the classic stable version [v1.22.22](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable) + - Installed with `"npm install -g yarn"` + ### Programming Languages/Services 1. React diff --git a/docs/pages/security.mdx b/docs/pages/security.mdx index c26c9fa9..f5817bba 100644 --- a/docs/pages/security.mdx +++ b/docs/pages/security.mdx @@ -40,9 +40,11 @@ Manually test and ensure, using the Firebase Storage Web APIs, that: 1. Public and signed-in users can only "READ" or download the PDF bulletin files. 2. Public and signed-in users cannot UPLOAD or DELETE files. -## Code base +## Codebase + +- Ensure that forked **climate-services-webportal-v1** (ACAP 1.0) or **acap-v2** (ACAP 2.0) monorepo code base or copies remain PRIVATE in GitHub. + -Ensure that the forked climate-services-webportal-v1 (ACAP 1.0) or acap-v2 (ACAP 2.0) monorepo code base remains PRIVATE in GitHub. ## User/Admin Accounts