From 56f21a24e4a241546483b15ce5d0d2cd84eb6f87 Mon Sep 17 00:00:00 2001 From: kyleecodes Date: Thu, 19 Dec 2024 23:01:19 -0500 Subject: [PATCH] Docs: add minimum specs --- README.md | 4 ++-- docs/database-guide.md | 5 +++++ docs/local-development.md | 13 ++++++++----- 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 665e7317..0563cc7f 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Chayn's Bloom service offers several key features designed to support individual ## Bloom Backend Technical Documentation -Read our [Bloom Backend Technical Wiki Docs](https://github.com/chaynHQ/bloom-backend/wiki/Key-Concepts-and-Architecture) for overviews of key concepts and data & database architecture. +Read our [Bloom Backend Tech Wiki Docs](https://github.com/chaynHQ/bloom-backend/wiki) for overviews of key concepts and data & database architecture. Technologies Used: @@ -38,7 +38,7 @@ Technologies Used: - [GitHub Actions](https://github.com/features/actions) - CI pipeline - [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) for linting and formatting. -## Local development +## Local Development Making an open-source contribution you have agreed to our [Code of Conduct](/CODE_OF_CONDUCT.md). diff --git a/docs/database-guide.md b/docs/database-guide.md index d0b073bd..0deaf1d9 100644 --- a/docs/database-guide.md +++ b/docs/database-guide.md @@ -2,6 +2,11 @@ ## How to Populate the Database +**Prerequisites:** + +- [Postgres 16](https://www.postgresql.org/download/) \*technically not required if running in Docker +- Running Bloom’s backend + ### Summary Most open-source contributions (like running Cypress integration tests from the frontend) require adding test data to your local database. To do this, download Bloom's test data dump file, connect to the database server, then populate the database with the backup data. diff --git a/docs/local-development.md b/docs/local-development.md index 7c2c3cb8..11c16a08 100644 --- a/docs/local-development.md +++ b/docs/local-development.md @@ -24,6 +24,14 @@ To test the backend: - Docker - PostgreSQL 16 +#### Recommended Minimum System Requirements: + +- CPU: Quad-core 2.5 GHz (i5/Ryzen 5) +- Memory: 16 GB RAM +- Storage: 512 GB +- OS: Linux, macOS, Windows, or WSL2 (latest versions) +- Internet Connection: For accessing dependencies and external APIs/services + ## Configure Environment Variables See [configure-env.md](configure-env.md) for instructions on configuring environment variables. @@ -138,11 +146,6 @@ Populating your local database with test data is required for running Cypress in See the [database-guide.md](database-guide.md) for instructions. -**Prerequisites:** - -- [Postgres 16](https://www.postgresql.org/download/) \*_technically not required if using the Docker method, but recommended._ -- Running Bloom’s backend - # Git Flow and Deployment **The develop branch is our source of truth, not main.**