Skip to content

brilliantfantastic/bf

Repository files navigation

Brilliant Fantastic

A treehouse on the internet.

For the best experience reading this README, please set the mood first.

DESCRIPTION

Brilliant Fantastic is the personal website of Jamie Wright. It features a dual-theme experience — a clean brutalist "Brilliant" side and an expressive, playful "Fantastic" side — with a blog, contact form, and animated illustrations.

INSTALLATION

  • Install the dependencies
mix deps.get
  • Create the database

You may need to adjust the database connection string in config/dev.exs.

mix ecto.create
  • Start the Phoenix server
mix phx.server

Now you can visit localhost:4000 from your browser.

TESTING

You can run the tests with the standard mix command:

mix test

You can also run the full precommit suite:

mix precommit

This runs compilation with warnings as errors, dependency audit, formatting, and tests.

DEPLOYMENT

This application is deployed to Gigalixir using buildpacks.

The application is automatically deployed to production when code is merged into the main branch. CI must pass before deployment is triggered.

The production application lives at https://bf.lol.

Services used

Manual deployment

  1. Install the Gigalixir CLI
brew tap gigalixir/brew && brew install gigalixir
  1. Log in
gigalixir login
  1. Add the git remote
gigalixir git:remote bf
  1. Deploy
git push gigalixir main:master
  1. Run migrations (if necessary)
gigalixir ps:migrate

CONTRIBUTING

  1. Clone the repository git clone https://github.com/brilliantfantastic/bf
  2. Create a feature branch git checkout -b my-awesome-feature
  3. Codez!
  4. Commit your changes (small commits please)
  5. Push your new branch git push origin my-awesome-feature
  6. Create a pull request

About

The entryway for all things brilliant and fantastic

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors