Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs fix spelling issues #502

Merged
merged 2 commits into from
Dec 20, 2024
Merged

Docs fix spelling issues #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea78a2a
Update README.md
nnsW3 Nov 2, 2024
3b6657c
Update .env.example
nnsW3 Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 = ''
NEXT_PUBLIC_SEGMENT_WRITE_KEY = ''
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down