simon/youyesyet
simon/youyesyet
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Starting salvage operation; documenting things which need doing.

Browse source
This commit is contained in:
Simon Brooke 2022-06-16 15:56:02 +01:00
parent c9c9d09b97
commit f93a0e854a
No known key found for this signature in database
GPG key ID: A7A4F18D1D4DF987
4 changed files with 19 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -10,7 +10,7 @@ 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.
Alpha level code. Most of it works, but it's a bit fragile.
## What is it supposed to do?
@ -36,6 +36,19 @@ Where *username* is the username required to access the database, and *thisisnot
It will be helpful for you to have the [Zenhub](https://www.zenhub.com/) plugin in your browser, either Firefox or Chrome, as I'm using it for project planning.
## Build procedure
YouYesYet is build on the [Application Description Language](https://github.com/simon-brooke/adl) framework, which is also mine and not widely used. Application Description Language is a very high level descriptor language for applications, which allows a huge amount of code to be automatically generated. This generated code is **not** checked into the repository; instead, you must regenerate it before you can build.
Consequently, to get a build running:
1. clone the repository, if you have not already done so;
2. within your cloned repository, check out a branch (usually `develop` or `master`);
3. if you have previously built the project within your cloned repository, run `lein clean`;
4. **this is the important bit** run `lein adl` to generate much of the application code;
5. run `lein run` to start your development server;
6. if you want to do client debugging, you'll want to run `figwheel` in a separate process, but also from the same cloned repository directory; I normally do this by opening a second terminal and invoking `lein figwheel`.
## 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](https://github.com/yogthos)'s [Web Development with Clojure, Second Edition](https://pragprog.com/book/dswdcloj2/web-development-with-clojure-second-edition).