Code Monkey home page Code Monkey logo

lucidboard's Introduction

Lucidboard

A realtime, collaborative kanban tool, built on Elixir, Phoenix, and LiveView.

Status: We've met our MVP goals! Now we're just adding features. As always, pull requests welcome!

CI: Lucidboard on CircleCI CircleCI

To start your Phoenix development environment:

bin/dev

Note: If you are on the Quicken Loans network, you'll want to invoke this script with bin/dev --ql or you will get errors around HTTPS authentication.

The script's comments explain a bit more, but you'll get two docker containers -- a Postgres database (lucidboard_dev_db) and an Elixir development container (lucidboard_dev_app). The script will then run the fish shell inside the latter, dropping you into /app where the project files reside.

When running this the first time, you'll need to install the dependencies and initialize the database. (You may also simply type setup since it is an alias for these commands.)

mix deps.get
cd assets; npm install; cd ..
mix ecto.setup

Finally, start the application with imp. This is an alias for iex -S mix phx.server which will run the app with Elixir's interactive repl, iex. This will allow you to test lines of Elixir code and interact with the running application. imp is the only command you'll need next time, now that things are installed.

imp

Now you can visit localhost:8800 from your browser.

To close down and remove the docker containers, run the following script. Don't worry - all your code and database data will remain intact for next time.

bin/down

Shell Aliases

These recommended few aliases are imported to the fish shell in the docker-based dev environment.

Alias Full Command
imp iex -S mix phx.server
im iex -S mix
mdg iex mix deps.get
mdu mix deps.update --all
mt mix test
mtw mix test.watch
ml mix lint
mer mix ecto.reset
setup mix deps.get
cd assets; npm install; cd ..
mix ecto.setup

License

Per the included LICENSE.txt, Lucidboard is made available under the MIT license.

lucidboard's People

Contributors

djthread avatar janinavelasco9 avatar craheb avatar tiridor avatar jsweiss avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.