Revert "Rebrand nounspace to blankspace (#1699)"

This reverts commit b6145c3.

Author: j-paterson

README.md

@@ -1,116 +1,145 @@
-# Blankspace
+# nounspace
 
-**A platform where communities build their home on Farcaster.**
+**Highly customizable [Farcaster](https://farcaster.xyz/) client, initially funded by a grant from [Nouns DAO](https://nouns.wtf/).** Customize the look, sound, content, and functionality of your public profile space and personal feed/homebase with **Themes**, **Tabs**, and a growing library of mini-apps called **Fidgets**.
 
-Blankspace gives token communities, DAOs, and Farcaster channels a customizable homebase with community tools (fidgets) for governance, token management, feeds, and more. Each community gets their own branded experience with custom themes, navigation, and pages.
 
-Initially funded by a grant from [Nouns DAO](https://nouns.wtf/). Forked from [herocast](https://github.com/hellno/herocast/) in April 2024.
+Forked from [herocast](https://github.com/hellno/herocast/) in April 2024.
 
-## Docs
-
-📚 **[View Full Documentation](https://blankdotspace.github.io/space-system/docs/)**
-
-Quick links:
-- [Getting Started](docs/GETTING_STARTED.md) - Local development setup
-- [Architecture](docs/ARCHITECTURE/OVERVIEW.md) - System design
-- [Contributing](docs/CONTRIBUTING.md) - How to contribute
-
-> Documentation source: [`docs/`](docs/) • Docusaurus site: [`docs-site/`](docs-site/)
+# Docs
+https://docs.nounspace.com/nounspace-alpha/
 
 ## What is Farcaster?
-
-A protocol for decentralized social apps: https://www.farcaster.xyz
+a protocol for decentralized social apps: https://www.farcaster.xyz
 
 ## 🏗️ Dev Setup
 
 1. **Clone the repo**  
    ```bash
-   git clone https://github.com/blankdotspace/space-system.git
-   cd space-system
-   ```
-
+   git clone https://github.com/Nounspace/nounspace.ts.git
+   cd nounspace.ts
 2. **Install Supabase CLI**
-
-   On macOS:
+   On Mac OS, for example:
    ```bash
    brew install supabase/tap/supabase
+   ```
+
+   Install Docker Desktop on macOS:
+   ```bash
    brew install --cask docker
    open /Applications/Docker.app
    ```
    Wait for Docker Desktop to finish initializing before continuing.
 
-   On Linux (Debian/Ubuntu):
+   On Linux:
+
+   First, install Homebrew (if not already installed):
    ```bash
-   # Install Homebrew if needed
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+   ```
+   Follow the instructions in your terminal to add Homebrew to your PATH.
+   Generally, you'll need to run these commands (replace `.bashrc` with your shell configuration file if different):
+
+   ```bash
+   (echo; echo 'eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"') >> ~/.bashrc
+   eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+   ```
    
-   # Install Supabase
+   You may also need to install some dependencies first (Debian/Ubuntu):
+   ```bash
+   sudo apt-get install build-essential procps curl file git
+   ```
+
+   Then install Supabase:
+   ```bash
    brew install supabase/tap/supabase
-   
-   # Install Docker
+   ```
+
+   Install Docker (Debian/Ubuntu):
+   ```bash
    sudo apt-get update
    sudo apt-get install -y docker.io docker-compose-plugin
    sudo systemctl enable --now docker
    sudo usermod -aG docker "$USER"
    ```
-   Log out/in for Docker group membership to take effect.
+   Log out/in (or restart your shell) so the new group membership takes effect.
+   For other distros, follow the [official Docker Engine docs](https://docs.docker.com/engine/install/).
 
-3. **Install dependencies**
+   Make sure Docker is installed and running before continuing.
+4. Install dependencies
    ```bash
    yarn install
-   ```
-
-4. **Set up environment variables**
-
-   Create `.env.development.local` with:
-   - `NEYNAR_API_KEY` - [Neynar API](https://docs.neynar.com/docs)
-   - `NEXT_PUBLIC_ALCHEMY_API_KEY` - [Alchemy](https://www.alchemy.com)
-   - `ETHERSCAN_API_KEY` - [Etherscan](https://docs.etherscan.io/getting-started/)
-   - `COINGECKO_API_KEY` - [CoinGecko](https://www.coingecko.com/en/api)
-   - `CLANKER_API_KEY` - Request from the Blankspace or Clanker team
-   - `YOUTUBE_API_KEY` - [YouTube API](https://developers.google.com/youtube/v3)
-   - `NEXT_PUBLIC_APP_FID` + `APP_MNEMONIC` - Your Farcaster account
-   - Supabase keys (from step 5)
-
-5. **Start Supabase and run migrations**
+6. Create a file `.env.development.local`
+7. Get the environment variables you need for the file <br>
+  a. get a Neynar API key https://docs.neynar.com/docs -> `NEYNAR_API_KEY` <br>
+  b. get an Alchemy API key https://www.alchemy.com -> `NEXT_PUBLIC_ALCHEMY_API_KEY` <br>
+  c. get an Etherscan API key https://docs.etherscan.io/getting-started/ -> 'ETHERSCAN_API_KEY' <br>
+  d. get a CoinGecko API key https://www.coingecko.com/en/api -> 'COINGECKO_API_KEY' <br>
+  e. get a Clanker API key https://github.com/clanker-devco/DOCS -> 'CLANKER_API_KEY' (dev portal coming soon; request a key from the nounspace or Clanker team for now) <br>
+  f. get a Youtube API key https://developers.google.com/youtube/v3 -> 'YOUTUBE_API_KEY' <br>
+  g. get your Farcaster account FID and mnemonic -> `NEXT_PUBLIC_APP_FID` + `APP_MNEMONIC`<br>
+  h. launch local copy of Supabase with `supabase start` (in the root directory of this repo), use the info provided -> <br>
+`API URL`:`NEXT_PUBLIC_SUPABASE_URL` + `anon key`:`NEXT_PUBLIC_SUPABASE_ANON_KEY`
+
+8. Run the setup script
+```bash
+./setup.sh
+```
+The script will attempt to start Supabase automatically if Docker is running; otherwise it will skip this step.
+
+9. **Seed the local database**
+   After Supabase is running and migrations are applied, seed the database:
    ```bash
-   supabase start
+   # Run migrations and seed SQL (if not already done)
    supabase db reset
-   ```
-   Use the `API URL` for `NEXT_PUBLIC_SUPABASE_URL` and `anon key` for `NEXT_PUBLIC_SUPABASE_ANON_KEY`.
-
-6. **Seed the local database**
-   ```bash
+   
+   # Seed community configs and navPage spaces
    yarn seed
    ```
    
-   This creates storage buckets, community configs, domain mappings, and NavPage registrations.
-   
-   Verify seeding worked:
-   ```bash
-   yarn seed --check
-   ```
+   This will:
+   - Upload Nouns assets to ImgBB (if `NEXT_PUBLIC_IMGBB_API_KEY` is set)
+   - Create navPage space registrations
+   - Seed community configs (nouns, example, clanker)
+   - Upload navPage space configs to Supabase Storage
 
-7. **Run the test suite**
+10. Run the test suite
    ```bash
    yarn test
    ```
 
-8. **Build and run**
-   ```bash
-   cp .env.development.local .env.local
-   yarn build
-   yarn dev
-   ```
+11. cp .env.development.local .env.local
+12. yarn build
+
+## Contributing and making Fidgets
+
+See the [contributing docs](docs/CONTRIBUTING.MD) for how to add to the code base. Register on [Scout Game](https://scoutgame.xyz/) to earn points for contributions to repos in the [nounspace org](https://github.com/Nounspace/).
+
+## Code Design
+
+The Nounspace App follows the Atomic Design Pattern
+![atomic_design](https://github.com/Nounspace/nounspace.ts/assets/7180740/2c892612-c730-4e74-bd32-3e7a8a6babbb)
+
+`src/pages` holds the Page elements of the atomic design. These are separated from `src/common` due to how Next.js handles routing.
+
+`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 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
 
-## Contributing
+`src/constants` contains all static information that is needed to run the app. This includes actual constants, along with some global types
 
-See the [contributing docs](docs/CONTRIBUTING.md) for how to add to the codebase. Register on [Scout Game](https://scoutgame.xyz/) to earn points for contributions to repos in the [blankdotspace org](https://github.com/blankdotspace/).
+### Refactoring
 
-## License
+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 them to correct file or folder. For example, there are some constants that are not placed in the `src/constants` directory, and instead are in the other files.
 
-Blankspace is released under the GPL-3.0 License. Feel free to fork and modify—just be sure any version you release uses the GPL-3.0 License too.
+### DB scheme: accounts
+reminder: key is an edcsa key not a 'normal' EVM address
 
-**Made with ❤️ by the Blankspace team & community.**
+### License
+nounspace is released under the GPL-3.0 License. Feel free to fork and modify the project—just be sure any version you release uses the GPL-3.0 License too.
 
-Questions or feedback? Create a [GitHub issue](https://github.com/blankdotspace/space-system/issues) or contact us in [Discord](https://discord.gg/eYQeXU2WuH)
+**Made with ❤️ by the Nounspace team & community.**
+Questions or feedback? Create a [Github issue](https://github.com/Nounspace/nounspace.ts/issues) or contact us in [Discord](https://discord.gg/eYQeXU2WuH)

docs/ARCHITECTURE/AUTHENTICATION.md

@@ -1,6 +1,6 @@
 # Authentication System
 
-The Blankspace authentication system combines Privy for wallet-based authentication with Farcaster for social identity, creating a seamless Web3 social experience.
+The Nounspace authentication system combines Privy for wallet-based authentication with Farcaster for social identity, creating a seamless Web3 social experience.
 
 ## Architecture Overview
 

docs/ARCHITECTURE/OVERVIEW.md

@@ -1,6 +1,6 @@
 # Architecture Overview
 
-Blankspace is built on a modern, modular architecture that combines Next.js App Router with Zustand state management, creating a highly customizable Farcaster client experience.
+Nounspace is built on a modern, modular architecture that combines Next.js App Router with Zustand state management, creating a highly customizable Farcaster client experience.
 
 ## High-Level Architecture
 

docs/ARCHITECTURE/STATE_MANAGEMENT.md

@@ -1,6 +1,6 @@
 # State Management Architecture
 
-Blankspace uses a sophisticated Zustand-based state management system with store composition, persistence, and optimistic updates.
+Nounspace uses a sophisticated Zustand-based state management system with store composition, persistence, and optimistic updates.
 
 ## Architecture Overview
 

docs/CONTRIBUTING.md

@@ -1,17 +1,17 @@
 # Contributing
 
-To add any code to the `blankdotspace/space-system` repo, you will need to open a PR.
+To add any code to the `nounspace/Nounspace.ts` repo, you will need to open a PR.
 
 ## TypeScript
-Blankspace is written fully in TypeScript with strict type checking enabled.
+Nounspace is written fully in TypeScript with strict type checking enabled.
 
 ## Steps to open a PR
-Blankspace expects its contributors to follow the "Fork and Pull" method to open PRs. Below is a TL;DR for this process
+Nounspace expects its contributors to follow the "Fork and Pull" method to open PRs. Below is a TL;DR for this process
 
-1. Fork `blankdotspace/space-system`
+1. Fork `nounspace/Nounspace.ts`
   a. Press the `fork` button at the top of the page
   b. Copy the fork locally (`git clone {your url}`)
-  c. Set up the `upstream` to `blankdotspace/space-system` (`git remote add upstream [email protected]:blankdotspace/space-system.git`)
+  c. Set up the `upstream` to `nounspace/Nounspace.ts` (`git remote add upstream [email protected]:Nounspace/nounspace.ts.git`)
 2. Make changes in your fork
 3. Commit your changes to your fork and push them to Github
 4. Open a PR in the Github webapp

docs/DEVELOPMENT/AGENTS.md

@@ -1,7 +1,7 @@
-# Blankspace Codex Instructions
+# Nounspace Codex Instructions
 
 ## Project Snapshot
-- **Product**: Blankspace – a highly customizable Farcaster client funded by Nouns DAO.
+- **Product**: Nounspace – a highly customizable Farcaster client funded by Nouns DAO.
 - **Core Concepts**: Spaces (customizable hubs), Tabs (layout blocks), Themes (visual skins), and Fidgets (mini-apps that augment a space).
 - **Tech Stack**: Next.js (App Router), TypeScript, React, Tailwind CSS, Zustand (with mutative middleware), React Query, Axios, Supabase, Privy-based auth, and Wagmi/Viem for blockchain integrations.
 

docs/DEVELOPMENT/COMPONENT_ARCHITECTURE.md

@@ -1,6 +1,6 @@
 # Component Architecture
 
-Blankspace follows atomic design principles with a modular component architecture that promotes reusability, maintainability, and scalability.
+Nounspace follows atomic design principles with a modular component architecture that promotes reusability, maintainability, and scalability.
 
 ## Atomic Design Structure
 

docs/DEVELOPMENT/DEBUGGING.md

@@ -1,6 +1,6 @@
 # Debugging Guide
 
-This guide covers debugging strategies, tools, and techniques for the Blankspace codebase to help developers identify and resolve issues effectively.
+This guide covers debugging strategies, tools, and techniques for the Nounspace codebase to help developers identify and resolve issues effectively.
 
 ## Debugging Philosophy
 

docs/DEVELOPMENT/DEVELOPMENT_GUIDE.md

@@ -1,8 +1,8 @@
-# Blankspace - Instructions
+# Nounspace - Instructions
 
 ## 1. Overview
 
-Blankspace is a highly customizable [Farcaster](https://farcaster.xyz/) client, initially funded by a grant from [Nouns DAO](https://nouns.wtf/). The project aims to provide users with a unique social media experience where they can personalize their profile space and personal feed with Themes, Tabs, and mini-applications called Fidgets.
+Nounspace is a highly customizable [Farcaster](https://farcaster.xyz/) client, initially funded by a grant from [Nouns DAO](https://nouns.wtf/). The project aims to provide users with a unique social media experience where they can personalize their profile space and personal feed with Themes, Tabs, and mini-applications called Fidgets.
 
 ### Problem Statements
 - Traditional social media platforms offer limited customization options
@@ -206,7 +206,7 @@ export const createStoreFunc = (
 ## 5. User Stories
 
 ### Visitor
-- As a visitor, I want to explore public spaces to understand what Blankspace offers
+- As a visitor, I want to explore public spaces to understand what Nounspace offers
 - As a visitor, I want to easily sign up and create my own space
 - As a visitor, I want to browse through different themes and layouts
 
@@ -219,13 +219,13 @@ export const createStoreFunc = (
 ### Active User
 - As an active user, I want to switch between different layouts for different contexts
 - As an active user, I want to organize my content with custom tabs
-- As an active user, I want to interact with frames and mini-apps within Blankspace
+- As an active user, I want to interact with frames and mini-apps within Nounspace
 - As an active user, I want to view my notifications and messages in one place
 - As an active user, I want to share my customized space with others
 
 ### Developer
-- As a developer, I want to create new fidgets that integrate with the Blankspace ecosystem
-- As a developer, I want to contribute to the Blankspace codebase following established patterns
+- As a developer, I want to create new fidgets that integrate with the Nounspace ecosystem
+- As a developer, I want to contribute to the Nounspace codebase following established patterns
 - As a developer, I want to implement new themes and layouts for the community
 
 ## 6. APIs and Integrations

docs/DEVELOPMENT/DEVELOPMENT_NOTES.md

@@ -1,4 +1,4 @@
-# Blankspace Layout & Mobile Navbar Refactor
+# Nounspace Layout & Mobile Navbar Refactor
 
 ## Phase 1: Research & Exploration Findings