https://github.com/alaingalvan/foil

✨ 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.
https://github.com/alaingalvan/foil

cms portfolio

Last synced: about 2 months ago
JSON representation

✨ 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.

• Host: GitHub
• URL: https://github.com/alaingalvan/foil
• Owner: alaingalvan
• License: mit
• Created: 2023-12-23T18:41:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-09T23:11:08.000Z (4 months ago)
• Last Synced: 2024-09-10T03:28:22.758Z (4 months ago)
• Topics: cms, portfolio
• Language: Rust
• Homepage: https://alain.xyz/libraries/foil
• Size: 339 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        


# 

[![License][license-img]][license-url]

[![Unit Tests][actions-img]][actions-url]



✨ 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](https://www.rust-lang.org/), [Node.js](https://nodejs.org/en), [TypeScript](https://www.typescriptlang.org/), [React](https://reactjs.org/), [GraphQL](https://graphql.org/), and [PostgreSQL](https://www.postgresql.org/).

## Getting started

### 🌟 Installation

Install the following prior to running foil:

- [Node.js](https://nodejs.org) - Version 16 LTS or higher.

- [PostgreSQL](https://www.postgresql.org/) - Version 13 or higher.

- [Rust Language](https://www.rust-lang.org/) (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](/releases) page for built binaries, and expose the `/bin` folder to your `PATH`.

### ✨ Usage

```bash

# 🛠️ Build your foil project, both the frontend and the portfolio, whatever's changed recently.

foil-cli build

# 🏃‍♂️ start the foil server.

foil-cli server start

```

[license-img]: https://img.shields.io/:license-mit-blue.svg?style=flat-square

[license-url]: https://opensource.org/license/mit/

[actions-img]: https://img.shields.io/github/actions/workflow/status/alaingalvan/foil/ci.yml?style=flat-square

[actions-url]: https://github.com/alaingalvan/foil/actions/