8000 GitHub - mcka1n/level: Distraction-free communication for software teams
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

mcka1n/level

 
 

Repository files navigation

Level

CircleCI

Level is an alternative to real-time chat designed for the software development workflow.

Sign up at level.app to reserve your handle and get on the updates list.

Project Status

Level is currently in the pre-launch phase and under active development by a small groups of people. Most tasks are being tracked offline as the foundations of the product come together, in the interest of rapid development and reaching an alpha stage for companies to start using it as quickly as possible.

Interested in helping out? My goal is to (eventually) keep some tasks filed in the issue tracker marked as good candidates for community contribution.

Developer Setup

You'll need to install the following dependencies first:

Run the bootstrap script to install the remaining dependencies and create your development database:

cd level
script/bootstrap

If your local PostgreSQL install does not have a default postgres user, open the config/dev.secret.exs file and update the credentials. Then, run the bootstrap script again.

Use the script/server command to start up your local server and visit localhost:4000 from your browser.

Installing Node.js

This repository includes a .nvmrc file targeting a specific version of Node that is known to be compatible with all current node dependencies. Things might work with a newer version of Node, but the most guaranteed route is to install Node Version Manager and run nvm install from the project root.

Then, be sure to run script/bootstrap to install node dependencies with the correct version of node.

Running tests and analyses

We have a handful of helper scripts available:

  • script/elixir-test: runs the Elixir test suite with coveralls
  • script/elm-test: runs the Elm test suite
  • script/test: runs the Elixir and Elm test suites
  • script/static-analysis: runs Credo (Elixir linting), Dialyzer, and Elixir formatter verification
  • script/build: runs all the test suites and static analysis

Documentation

Run the script/docs to generate and view the project ExDocs locally.

Heroku Deployment (Experimental)

One of our goals is to make self-installation as painless as possible for those who are interested in hosting their one instance.

The relevant configuration files for Heroku live here:

We are aiming to keep seamless Heroku deployment up-to-date, with a few important "alpha software" notes:

  • It's possible you may find it broken on master. If you do, please file an issue.
  • As deployment needs grow more complex, it may become no longer feasible to support Heroku deploys. Caveat emptor.

Required additional services

In addition to a Heroku account, you'll need the following services to get your Heroku install up and running:

  • An AWS account and an S3 bucket for storing file uploads. You'll be asked for AWS API keys and bucket name environment variables during setup.
  • A transactional email provider (we recommend Postmark). You'll be asked for SMTP host, port, username, and password environment variables during setup.

Deploy

Copyright

© 2018 Level Technologies, LLC

Licensed under the Apache License, Version 2.0.

About

Distraction-free communication for software teams

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Elixir 48.2%
  • Elm 39.8%
  • JavaScript 4.2%
  • CSS 3.9%
  • HTML 3.5%
  • Shell 0.4%
0