From ea78a2a4f8c955af7f5b16fb38600dae5d555c4b Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 2 Nov 2024 18:10:54 +0200 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a8871a22..56ec43e9 100644 --- a/README.md +++ b/README.md @@ -35,17 +35,17 @@ The Nounspace App follows the Atomic Design Pattern `src/common/ui` contains all of the display components for all other layers of the atomic design. `src/common/ui/components` are a mixture of Molecules and Organisms that were imported from `herocast`, they still need to be split into their appropriate folders (`src/common/ui/molecules` & `src/common/ui/organisms`). -`src/common/data` contains the access to datastreams, in the form of database connections and API's +`src/common/data` contains access to datastreams, in the form of database connections and API's `src/common/lib` contains useful functions for accessing formatted data, along with helpers functions inside the `utils` directory. `src/styles` contains information for managing website styling -`src/constants` contains all static information that is the needed to run the app. This includes actual constants, along with some global types +`src/constants` contains all static information that is needed to run the app. This includes actual constants, along with some global types ### Refactoring -This file structure is adapted from `herocast`, and not all files have been cleaned up properly. If you find files or data that is placed in the wrong location, please refactor it. For example, there are some constants that are not placed in the `src/constants` directory, and instead are in the other files +This file structure is adapted from `herocast`, and not all files have been cleaned up properly. If you find files or data that are placed in the wrong location, please refactor it. For example, there are some constants that are not placed in the `src/constants` directory, and instead are in the other files ### DB scheme: accounts From 3b6657cb1b240b95fca04803804947f48d6e6364 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 2 Nov 2024 18:11:59 +0200 Subject: [PATCH 2/2] Update .env.example --- .env.example | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index 3b0533f1..35188d7f 100644 --- a/.env.example +++ b/.env.example @@ -5,7 +5,7 @@ NEXT_PUBLIC_VERCEL_ENV = development NEXT_PUBLIC_URL = 'http://localhost:3000' NEXT_PUBLIC_MOD_PROTOCOL_API_URL = 'https://api.modprotocol.org/api' -# The following are sensative data and should +# The following are sensitive data and should # be stored in a .env.development.local file # for local development, and are hosted in Vercel # for production use cases @@ -14,12 +14,12 @@ APP_MNENOMIC = 'candy maple cake sugar honey ... potato blue' NEYNAR_API_KEY = '' SUPABASE_SERVICE_KEY = '' YOUTUBE_API_KEY = '' -# These are sepecific to the environment +# These are specific to the environment # and so need to be configured locally -# but are not sensative data +# but are not sensitive data NEXT_PUBLIC_APP_FID = '123' NEXT_PUBLIC_SUPABASE_URL = '' NEXT_PUBLIC_SUPABASE_ANON_KEY = '' NEXT_PUBLIC_PRIVY_API_KEY = '' NEXT_PUBLIC_ALCHEMY_API_KEY = '' -NEXT_PUBLIC_SEGMENT_WRITE_KEY = '' \ No newline at end of file +NEXT_PUBLIC_SEGMENT_WRITE_KEY = ''