Skip to content

Commit

Permalink
Merge pull request #6 from Nounspace/readme-update
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
j-paterson authored Apr 18, 2024
2 parents fe1d250 + 3b557d6 commit ef3276b
Showing 1 changed file with 17 additions and 31 deletions.
48 changes: 17 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,34 @@
# Nounspace
Forked from [herocast](https://github.com/hellno/herocast/)
[![build](https://github.com/hellno/herocast/actions/workflows/build.yaml/badge.svg)](https://github.com/hellno/herocast/actions/workflows/build.yaml)
![herocast_cartridge_landscape](https://github.com/hellno/herocast/assets/686075/f6925730-6e41-4729-93c0-4ce617b15aee)


'Superhuman for Farcaster'
= keyboard-first. support for multiple accounts and switching channels. cmd + k (command palette) to control everything.
Forked from [herocast](https://github.com/hellno/herocast/)

## What is Farcaster?
a protocol for decentralized social apps: https://www.farcaster.xyz

## 🏗️ Dev Setup

- register with Supabase and create a new project https://supabase.com
- get a Neynar API key https://docs.neynar.com/docs
- get an Alchemy API key https://www.alchemy.com
- get your Farcaster account FID and mnemoic

## Local setup

- Install Supabase CLI `https://github.com/supabase/cli`
- e.g. for MacOS with `brew install supabase/tap/supabase`

### install dependencies

```bash
yarn install
```

### run as website
1. Clone the repo
2. Install Supabase CLI: <br> e.g. for MacOS with `brew install supabase/tap/supabase`
3. Install dependencies `yarn install`
4. Create a file `.env.development.local`
5. Get the details you need for the file <br>
a. get a Neynar API key https://docs.neynar.com/docs -> `NEXT_PUBLIC_NEYNAR_API_KEY` <br>
b. get an Alchemy API key https://www.alchemy.com -> `NEXT_PUBLIC_ALCHEMY_API_KEY` <br>
c. get your Farcaster account FID and mnemoic -> `NEXT_PUBLIC_APP_FID` + `NEXT_PUBLIC_APP_MNENOMIC`<br>
d. launch local copy of Supabase with `supabase start`, use the info provided -> <br>
`API URL`:`NEXT_PUBLIC_SUPABASE_URL` + `anon key`:`NEXT_PUBLIC_SUPABASE_ANON_KEY`

```bash
yarn dev
```
## Code Design

run local DB in Docker
```bash
supabase db start
```
The Nounspace App follows the Atomic Design Pattern
![atomic_design](https://github.com/Nounspace/nounspace.ts/assets/7180740/2c892612-c730-4e74-bd32-3e7a8a6babbb)

Atoms and Moluclues can be found in the `src/common` foloder. Feel free to use existing ones or add your own.

### run as native app
Fidgets are a type of Organism, fulfilling the role of sections of a page. To build Fidgets, please add them to the `src/fidgets` directory.

...coming back soon via [tauri](https://tauri.app/)...
Templates are the Fidget grid. Pages are managed by Nounspace


### DB scheme: accounts
Expand Down

0 comments on commit ef3276b

Please sign in to comment.