Skip to content

alaingalvan/foil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Foil

License Unit Tests

✨ Foil is an content management system designed for engineers, artists, technical artists, musicians, and bloggers looking to showcase a portfolio of front-end experiments, games, art, articles, and more.

It's built on top of Rust, Node.js, TypeScript, React, GraphQL, and PostgreSQL.

Getting started

🌟 Installation

Install the following prior to running foil:

  • Node.js - Handles server-side rendering and JavaScript bundles.

  • PostgreSQL - Handles the foil post database cache.

  • Rust Language (optional) - The language the server and builder are written in. This isn't necessary if you run foil directly from a binary.

From there, visit the releases page for built binaries, and expose the folder to your PATH.

✨ Usage

# 🛠️ Build your foil project, both the frontend and the portfolio, whatever's changed recently.
foil-cli build # --dev (optional)

# 🏃‍♂️ start the foil server.
foil-cli server start

# ♻️ Reset the database cache.
foil-cli server reset

Environment Variables

Variable Default Description
FOIL_DATABASE_URL postgres://localhost/foil What postgres database to write the foil post cache to.
FOIL_HOSTNAME 127.0.0.1 Your hostname. Defaults to localhost.
FOIL_PORT 4017 Default port for the foil backend server.

About

✨ A portfolio CMS library designed for engineers, artists, technical artists, musicians, and bloggers looking to showcase a portfolio of front-end experiments, games, art, articles, and more.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors