OpenCompany Web Application

Overview

Transparency, honesty, kindness, good stewardship, even humor, work in businesses at all times.

-- John Gerzema

Employees and investors, co-founders and execs, they all want more transparency from their startups, but there's no consensus about what it means to be transparent. OpenCompany is a platform that simplifies how key business information is shared with stakeholders.

When information about growth, finances, ownership and challenges is shared transparently, it inspires new ideas and new levels of stakeholder engagement. OpenCompany makes it easy for founders to engage with employees and investors, creating a sense of ownership and urgency for everyone.

OpenCompany.io is GitHub for the rest of your company.

To maintain transparency, OpenCompany information is always accessible and easy to find. Being able to search or flip through prior updates empowers everyone. Historical context brings new employees and investors up to speed, refreshes memories, and shows how the company is evolving over time.

Transparency expectations are changing. Startups need to change as well if they are going to attract and retain savvy employees and investors. Just as open source changed the way we build software, transparency changes how we build successful startups with information that is open, interactive, and always accessible. The OpenCompany platform turns transparency into a competitive advantage.

Like the open companies we promote and support, the OpenCompany.io platform is completely transparent. The company supporting this effort, Transparency, LLC, is an open company. This platform is open source software, and open company data is open data accessible through the platform API.

To get started, head to: OpenCompany.io

Local Setup

Users of the OpenCompany.io platform should get started by going to OpenCompany.io. The following local setup is for developers wanting to work on the platform's Web application software.

Most of the dependencies are internal, meaning Leiningen will handle getting them for you. There are a few exceptions:

Java 8 - a Java 8 JRE is needed to run Clojure
Leiningen - Clojure's build and dependency management tool

Chances are your system already has Java 8 installed. You can verify this with:

java -version

If you do not have Java 8 download it and follow the installation instructions.

Leiningen is easy to install:

Download the latest lein script from the stable branch.
Place it somewhere that's on your $PATH (env | grep PATH). /usr/local/bin is a good choice if it is on your PATH.
Set it to be executable. chmod 755 /usr/local/bin/lein
Run it: lein This will finish the installation.

Then let Leiningen install the rest of the dependencies:

git clone https://github.com/open-company/open-company-web.git
cd open-company-web
lein deps

Usage

Users of the OpenCompany.io platform should get started by going to OpenCompany.io. The following usage is for developers wanting to work on the platform's Web application software.

To get an interactive development environment run:

lein figwheel

Open your browser to http://localhost:3449/.

This will auto compile and send all changes to the browser without the need to reload. After the compilation process is complete, you will get a Browser Connected REPL. An easy way to test it is:

(js/alert "Am I connected?")

You should see an alert in the browser window.

If you want to use the devcards for development, run:

lein devcards

Then load http://localhost:3449/devcards in your browser.

To clean all compiled files:

lein clean

To create a production build run:

lein build!

Open your browser in resources/public/index.html. You will not get live reloading nor a REPL.

Tests

Install PhantomJS downloading the latest binary here, the one from their site is currently broken.

Then move the phantomjs binary somewhere reachable by your PATH so you can run:

phantomjs -v

Then run:

lein test!

For more info on testing:

Plugin: bensu/doo
React simulate wrapper: bensu/cljs-react-test

Participation

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Distributed under the Mozilla Public License v2.0.

podviaznikov / open-company-web