youyesyet

A web-app intended to be used by canvassers campaigning for a 'Yes' vote in the second independence referendum.

The web-app will be delivered to canvassers out knocking doors primarily through an HTML5/React single-page app designed to work on a mobile phone; it's possible that someone else may do an Android of iPhone native app to address the same back end but at present I have no plans for this.

There must also be an administrative interface through which privileged users can set the system up and authorise canvassers, and a 'followup' interface through which issue-expert specialist canvassers can address particular electors' queries.

generated using Luminus version "2.9.11.05"

Status

Very early pre-alpha; user interface mostly works (enough to demonstrate), back end is hardly started.

What is it supposed to do?

To understand what I'm aiming for, read this essay. Design documentation, such as there is of it yet, is in the dummy sub-directory. Also look at src/clj/youyesyet/db/schema.clj.

Prerequisites

You will need Leiningen 2.0 or above installed. The database required must be Postgres 9.3 or above.

You'll also need to create your own local copy of profiles.clj, which should contain something like:

;; WARNING
;; The profiles.clj file is used for local environment variables, such as database credentials.
;; This file is listed in .gitignore and will be excluded from version control by Git.

{:profiles/dev  {:env {:database-url "jdbc:postgresql://127.0.0.1/youyesyet_dev?user=username&password=thisisnotsecure"}}
 :profiles/test {:env {:database-url "jdbc:postgresql://127.0.0.1/youyesyet_test?user=username&password=thisisnotsecure"}}}

Where username is the username required to access the database, and thisisnotsecure is the password which authenticates that username.

It will be helpful for you to have the Zenhub plugin in your browser, either Firefox or Chrome, as I'm using it for project planning.

Further Reading

If you're thinking of joining in development on this I'd strongly recommend you get hold of a copy of Dmitry Sotnikov's Web Development with Clojure, Second Edition.

You should also read the User-Oriented Specification and any other documentation which appears under the doc/specification hierarchy.

Getting the database up

You'll need a file profiles.clj, with content similar to the following; it's not in the repository because it contains passwords.

;; WARNING
;; The profiles.clj file is used for local environment variables, such as database credentials.
;; This file is listed in .gitignore and will be excluded from version control by Git.

{:profiles/dev  {:env {:database-url "jdbc:postgresql://127.0.0.1/youyesyet_dev?user=youyesyet&password=yourverysecurepassword"}}
 :profiles/test {:env {:database-url "jdbc:postgresql://127.0.0.1/youyesyet_test?user=youyesyet&password=yourverysecurepassword"}}}

Do get the database initialised, run

createdb youyesyet_dev

followed by

lein migratus migrate

NOTE THAT in the namespace youyesyet.db.schema, there are a series of functions create-xxx-table!. These are a snare and a delusion; they are how I originally bootstrapped the database, but are no longer used (and should probably be deleted). The database is now constructed using migratus.

Running in a dev environment

To run in a dev environment, checkout the develop branch

To start a development web server for the application, run:

lein run

If you're wanting to work on cljs development, you need two terminal sessions. In one run

lein run

as above; in the other, run

lein figwheel

Running in a production environment

Doesn't really work yet; if you want to try it, see Bug #36 and check out the associated feature branch.

Working on this project

You should get the ZenHub plug-in for your favourite browser; I use ZenHub for project management, and you (and I) will find collaborating much easier if you do. To join in

1. Clone the project from my repository;
2. Visit the kanban board and choose an issue you'd like to work on;
3. Assign that issue to yourself and move it into the 'in progress' column;
4. Use gitflow: start a new feature;
5. Work on the issue;
6. When you are satisfied with your work, commit it to your repository in your feature branch;
7. Submit a pull request and move the issue to the 'QA/Review' column on the kanban board;
8. If your work works, I'll integrate it into the develop branch, which you can then pull;
9. Rinse and repeat!

Obviously I'd appreciate it if you'd mail me to introduce yourself, but there's no need to do so.

Finally, if you take a ticket and are not able to finish it, please

1. mail me to say so;
2. move the issue back to the 'backlog' column on the kanban board.

And many thanks!

More about tooling

Note that all tools recommended in this document are free for non-commercial use; not all are open source.

Editors/IDEs

I (Simon) use, like and recommend LightTable as my editor; I used to use Emacs, and there is excellent Clojure tooling for Emacs, but these days Emacs ways of working seem just too far from everything else to be comfortable to me. NightCode is a lighter-weight Clojure IDE which you may like. There's also Cursive but it isn't free and I haven't tried it.

Git

I'm currently using GitKraken, on Linux, Windows, and Mac. Like so many things it works best on Linux, but it's good on both other platforms. However, I confess that although I like the ability to easily view the whole structure of the git repository, I tend to drop back to the command line if I'm doing anything tricky with Git.

Database

The database is Postgres. I have no plans even to support anything else; I don't feel we have time to mess about. However, if someone wants to fork the code and implement a different database, that's up to them. I'm afraid I do all database stuff from the command line; there are graphical tools for Postgres but personally I've never found graphical tools for databases much use.

Further Reading

If you're thinking of joining in development on this I'd strongly recommend you get hold of a copy of Dmitry Sotnikov's Web Development with Clojure, Second Edition.

You should also read the User-Oriented Specification and any other documentation which appears under the doc/specification hierarchy.

License

Copyright © 2016 Simon Brooke for the Radical Independence Campaign.

Licensed under the GNU General Public License, version 2.0 or (at your option) any later version.

NOTE THAT files which are directly created by the Luminus template do not currently have a GPL header at the top; files which are new in this project or which have been substantially modified for this project do have a GPL header at the top.