A location-based social network.

1. Install dependencies

• NodeJS (LTS recommended)
• Git
• If running Supabase locally:
  • Docker/Docker Engine

2. Clone the repository:

git clone https://github.com/ColoradoSchoolOfMines/beacon.git

3. Inside the repository, install the dependencies:

npm install

4. If you want to run Supabase locally, start the Docker container:

# This can take a while the first time you run it because it has to download a bunch of Docker images
npm run supabase:start

# Check the status of the Supabase (Including the dashboard URL and mock email server URL)
npm run supabase:status

5. Update .env with the appropriate values (See Frontend Environment Variables).

6. Still inside the repository, start the development server:

npm run dev

7. Open http://localhost:3000 in your browser to access the frontend

8. If running Supabase locally, reset the database after each schema change:

npm run supabase:reset

To build the frontend for production, run:

docker build -t beacon -f Dockerfile .

To run the frontend in production, run:

docker run -p 80:8080 beacon

• Frontend
  • Language: TypeScript
  • Web framework: React + Vite
  • Component library: Ionic React
  • Styling: UnoCSS (Wind preset) (Tailwind/WindiCSS compatible)
• Backend: Supabase

Beacon's ranking algorithm is somewhat inspired by the Lemmy algorithm, but has the following properties:

The algorithm is as follows:

$$ \text{Distance component} = (\text{Distance weight} - 1) \cdot (\min\bigg(1, \frac{\text{Distance}}{\text{Distance range}}\bigg) - 1)^{2} + 1 $$

$$ \text{Score component} = \log_{10}(\max(1, (\text{Upvotes} - \text{Downvotes}) - \text{Score threshold} + 1)) $$

$$ \text{Age component} = \text{Age weight}^{- \text{Age}} $$

$$ \text{Rank} = \lfloor(\text{Scale} \cdot \text{Distance component} \cdot \text{Score component} \cdot \text{Age component}\rfloor $$

with the following variables: