Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 1.65 KB

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

🔧 Setup

First, clone the repository (you need to have SSH configured on GitHub):

git clone [email protected]:cesium/cesium_cup.git
cd cesium_cup

Then, create the .env.[ENV] file and download dependencies.

cp -n .env.dev.sample .env.dev
mix deps.get

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

🔨 Development

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.

mix credo --strict --all

Format your code.

mix format

🔗 References

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