Skip to content

elixir-sea/typo_paint

 
 

Repository files navigation

TypoPaint

The TypoPiantPaint project is an attempt to develop a fun typing game in elixir using LiveView.

The goal of the project will be to enable focused opportunities for people in the Seattle area to collaborate on writing Elixir and LiveView code coming from different skill levels.

Development Instructions

For development, you'll need Elixir, Erlang and Node.js. If you use the asdf version manager and install the relevant plugins, you can install the versions specified in .tool-versions with asdf install.

Contributing

Anyone in the Seattle area can be a contributor. Ask in the #seattle or the #typo_kart channel in the Elixir-Lang slack group.

We are using a simple Pull Request model. Create a new branch based on master for you additions and then create a PR against master.

Pull requests require a code review from at least one other contributor, but then can be merged to master by anyone. The goal is to get new features into master as quickly as possible, so the reviewer should just merge once approved.

LiveView Documentation

Phoenix LiveView on hex.pm.

Deployment

Deployment instructions.

The Usual README Content

To start your Phoenix server:

  • Install dependencies with mix deps.get
  • Install Node.js dependencies with cd assets && npm install
  • Start Phoenix endpoint with mix phx.server

Now you can visit localhost:4000 from your browser.

Ready to run in production? Please check our deployment guides.

Learn more

Releases

No releases published

Packages

No packages published

Languages

  • Elixir 84.8%
  • CSS 9.4%
  • JavaScript 4.1%
  • Other 1.7%