remove ansible template, this will need it's own repo. Add deploy info to readme
This commit is contained in:
parent
e44ae9ecf5
commit
d81c795267
9 changed files with 60 additions and 122 deletions
69
README.md
69
README.md
|
@ -10,22 +10,67 @@ You will need [Leiningen][1] 2.0 or above installed.
|
||||||
|
|
||||||
[1]: https://github.com/technomancy/leiningen
|
[1]: https://github.com/technomancy/leiningen
|
||||||
|
|
||||||
## Running
|
|
||||||
|
|
||||||
Copy `dev-config.edn_example` to `dev-config.edn` and fill in the needed fields
|
## Development
|
||||||
|
|
||||||
`test-config.edn` is used for test execution.
|
### Running
|
||||||
|
|
||||||
To start a web server for the application, run:
|
Environment variables:
|
||||||
|
|
||||||
|
Copy `dev-config.edn_example` to `dev-config.edn` and fill in the needed fields.
|
||||||
|
|
||||||
|
Use `test-config.edn` for tests.
|
||||||
|
|
||||||
|
Install the needed dependecies
|
||||||
|
|
||||||
|
lein deps
|
||||||
|
|
||||||
|
To start the web server for the application, run:
|
||||||
|
|
||||||
lein run
|
lein run
|
||||||
|
|
||||||
To start the ui live rendering, run:
|
To start the clientside server (this watches the cljs files and automatically recompiles on change), run:
|
||||||
|
|
||||||
lein figwheel
|
lein figwheel
|
||||||
|
|
||||||
## Development
|
|
||||||
### Database
|
When making database schema changes, start a repl user environment using
|
||||||
|
|
||||||
|
lein repl
|
||||||
|
|
||||||
|
You can start the webserver in this repl using
|
||||||
|
|
||||||
|
(start)
|
||||||
|
|
||||||
|
Make a new database migration:
|
||||||
|
|
||||||
|
(create-migration "migration name")
|
||||||
|
|
||||||
|
Now edit the newly created .sql files.
|
||||||
|
|
||||||
|
Run the pending migrations
|
||||||
|
|
||||||
|
(migrate)
|
||||||
|
|
||||||
|
Roll back the last set of migrations
|
||||||
|
|
||||||
|
(rollback)
|
||||||
|
|
||||||
|
Reset the state of the database
|
||||||
|
|
||||||
|
(reset-db)
|
||||||
|
|
||||||
|
Restart the database (this is needed after changes in the sql querries)
|
||||||
|
|
||||||
|
(restart-db)
|
||||||
|
|
||||||
|
Note that you can't do this when running the server with `lein run`.
|
||||||
|
In this case you need to shutdown and restart using run or repl.
|
||||||
|
|
||||||
|
You can find these function available in the [userspace definitions][2]
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
#### Database
|
||||||
* ENUM TYPE
|
* ENUM TYPE
|
||||||
|
|
||||||
Because of the lack of typing in clojure and the forced typing of the jdbc driver
|
Because of the lack of typing in clojure and the forced typing of the jdbc driver
|
||||||
|
@ -35,6 +80,12 @@ we need to manually manage conversion of enum types to clojure keywords.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## Production
|
||||||
|
|
||||||
Copyright © 2019 FIXME
|
lein uberjar
|
||||||
|
|
||||||
|
export DATABASE_URL="jdbc:postgres://localhost:port/dbname?user=username&password=password"
|
||||||
|
java -jar target/uberjar/cat.jar
|
||||||
|
|
||||||
|
|
||||||
|
[2]: env/dev/clj/user.clj
|
||||||
|
|
|
@ -1,38 +0,0 @@
|
||||||
Role Name
|
|
||||||
=========
|
|
||||||
|
|
||||||
A brief description of the role goes here.
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
|
|
||||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
|
||||||
|
|
||||||
Role Variables
|
|
||||||
--------------
|
|
||||||
|
|
||||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
|
||||||
|
|
||||||
Dependencies
|
|
||||||
------------
|
|
||||||
|
|
||||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
|
||||||
|
|
||||||
Example Playbook
|
|
||||||
----------------
|
|
||||||
|
|
||||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
|
||||||
|
|
||||||
- hosts: servers
|
|
||||||
roles:
|
|
||||||
- { role: username.rolename, x: 42 }
|
|
||||||
|
|
||||||
License
|
|
||||||
-------
|
|
||||||
|
|
||||||
BSD
|
|
||||||
|
|
||||||
Author Information
|
|
||||||
------------------
|
|
||||||
|
|
||||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
|
|
@ -1,2 +0,0 @@
|
||||||
---
|
|
||||||
# defaults file for deploy-cat
|
|
|
@ -1,2 +0,0 @@
|
||||||
---
|
|
||||||
# handlers file for deploy-cat
|
|
|
@ -1,60 +0,0 @@
|
||||||
galaxy_info:
|
|
||||||
author: your name
|
|
||||||
description: your description
|
|
||||||
company: your company (optional)
|
|
||||||
|
|
||||||
# If the issue tracker for your role is not on github, uncomment the
|
|
||||||
# next line and provide a value
|
|
||||||
# issue_tracker_url: http://example.com/issue/tracker
|
|
||||||
|
|
||||||
# Some suggested licenses:
|
|
||||||
# - BSD (default)
|
|
||||||
# - MIT
|
|
||||||
# - GPLv2
|
|
||||||
# - GPLv3
|
|
||||||
# - Apache
|
|
||||||
# - CC-BY
|
|
||||||
license: license (GPLv2, CC-BY, etc)
|
|
||||||
|
|
||||||
min_ansible_version: 2.4
|
|
||||||
|
|
||||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
|
||||||
# min_ansible_container_version:
|
|
||||||
|
|
||||||
# Optionally specify the branch Galaxy will use when accessing the GitHub
|
|
||||||
# repo for this role. During role install, if no tags are available,
|
|
||||||
# Galaxy will use this branch. During import Galaxy will access files on
|
|
||||||
# this branch. If Travis integration is configured, only notifications for this
|
|
||||||
# branch will be accepted. Otherwise, in all cases, the repo's default branch
|
|
||||||
# (usually master) will be used.
|
|
||||||
#github_branch:
|
|
||||||
|
|
||||||
#
|
|
||||||
# Provide a list of supported platforms, and for each platform a list of versions.
|
|
||||||
# If you don't wish to enumerate all versions for a particular platform, use 'all'.
|
|
||||||
# To view available platforms and versions (or releases), visit:
|
|
||||||
# https://galaxy.ansible.com/api/v1/platforms/
|
|
||||||
#
|
|
||||||
# platforms:
|
|
||||||
# - name: Fedora
|
|
||||||
# versions:
|
|
||||||
# - all
|
|
||||||
# - 25
|
|
||||||
# - name: SomePlatform
|
|
||||||
# versions:
|
|
||||||
# - all
|
|
||||||
# - 1.0
|
|
||||||
# - 7
|
|
||||||
# - 99.99
|
|
||||||
|
|
||||||
galaxy_tags: []
|
|
||||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
|
||||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
|
||||||
# remove the '[]' above, if you add tags to this list.
|
|
||||||
#
|
|
||||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
|
||||||
# Maximum 20 tags per role.
|
|
||||||
|
|
||||||
dependencies: []
|
|
||||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
|
||||||
# if you add dependencies to this list.
|
|
|
@ -1,2 +0,0 @@
|
||||||
---
|
|
||||||
# tasks file for deploy-cat
|
|
|
@ -1,2 +0,0 @@
|
||||||
localhost
|
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
---
|
|
||||||
- hosts: localhost
|
|
||||||
remote_user: root
|
|
||||||
roles:
|
|
||||||
- deploy-cat
|
|
|
@ -1,2 +0,0 @@
|
||||||
---
|
|
||||||
# vars file for deploy-cat
|
|
Loading…
Reference in a new issue