fonio

(β˜… 66)

a collaborative scholarly text editor allowing to build static websites

File Explorer

Download Latest Version (.zip)
  • .dockerignore
  • .eslintrc
  • .gitignore
  • .travis.yml
  • 404.html
  • 50x.html
  • android-chrome-96x96.png
  • apple-touch-icon.png
  • browserconfig.xml
  • config.json
  • CONTRIBUTING.md
  • docker-cmd.sh
  • docker-nginx.conf
  • Dockerfile
  • favicon-16x16.png
  • favicon-32x32.png
  • favicon.ico
  • fonio-rs.png
  • index.html
  • index.prod.html.template
  • LICENSE
  • manifest.json
  • MANUAL_E2E_TESTS_CHECKLIST.md
  • mstile-150x150.png
  • package-lock.json
  • package.json
  • README.md
  • safari-pinned-tab.svg
  • webpack.config.dev.js
  • webpack.config.docker.js
  • webpack.config.prod.js
  • webpack.config.shared.js

# Installation Guide

1. Get the code
git clone https://github.com/medialab/fonio

Downloads the entire project code from GitHub to your computer.

cd fonio

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t fonio .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 fonio

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

npm run build # builds the app to build dir

Builds optimized production files.

npm run lint # lints (auto-fix on) the js code

Type this command into your terminal and run it.

npm run comb # prettifies (s)css code

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

Today's picks

taste-skill β˜… 78,877

Taste-Skill - gives your AI good taste. stops the AI from generating boring, generic slop

JavaScript
rtk β˜… 76,925

CLI proxy that reduces LLM token consumption by 60-90% on common dev commands. Single Rust

Rust
nvm β˜… 94,671

Node Version Manager - POSIX-compliant bash script to manage multiple active node.js versi

Shell
immich β˜… 112,236

High performance self-hosted photo and video management solution.

TypeScript
markitdown β˜… 175,168

Python tool for converting files and office documents to Markdown.

Python
three.js β˜… 114,653

JavaScript 3D Library.

JavaScript
// repository documentation