🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

📥 Prerequisites

The following software is required to be installed on your system:

We recommend using asdf version manager to install and manage all the programming languages' requirements.

First, clone the repository:

git clone git@github.com:cesium/yearbook.git
cd yearbook

Then, run the setup script to get all dependencies configured. The default value for ENV is dev.

bin/setup [ENV]

Then you should change the .env.dev file as needed. Run this script again if needed.

Start the development server and then you can visit http://localhost:4000 from your browser.

mix phx.server # or iex -S mix phx.server

Lint your code.

bin/lint

Format your code.

bin/format

Evaluate the project.

mix check

You can use these resources to learn more about the technologies this project uses.