Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abogoyavlensky/abogoyavlensky.github.io
Source of personal blog of Andrey Bogoyavlenskiy
https://github.com/abogoyavlensky/abogoyavlensky.github.io
articles blog clojure gh-pages profile static-site-generator
Last synced: 2 months ago
JSON representation
Source of personal blog of Andrey Bogoyavlenskiy
- Host: GitHub
- URL: https://github.com/abogoyavlensky/abogoyavlensky.github.io
- Owner: abogoyavlensky
- License: mit
- Created: 2017-07-14T11:27:38.000Z (over 7 years ago)
- Default Branch: dev
- Last Pushed: 2024-06-02T00:43:57.000Z (7 months ago)
- Last Synced: 2024-06-02T01:45:09.749Z (7 months ago)
- Topics: articles, blog, clojure, gh-pages, profile, static-site-generator
- Language: Clojure
- Homepage: https://abogoyavlensky.github.io/
- Size: 6.91 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Personal blog
## Publish article
### Add new article
Being in the `dev` branch add meta info about article to `resources/data/meta.edn`
to vector named `:articles` as map with fields:
```clojure
{:id 1 ; just to keep order
:slug "some-article-slug" ; will be used in url
:title "Some article name"
; Date format: `YYYY-MM-DD`
:date "2020-08-24" ; published date
:keywords ["tag" "will" "be" "used" "for" "seo"]
:description "A few words about main idea of article"}
```
Then you could add new file with article itself in markdown
to `resources/data/articles/some-article-slug.md`.
*Note that file must have the same name as article slug.*
### Deploy
Run deploy with commit message:
```shell script
make deploy 'Add some new article'
```
## Development
Requirements:
- java >= 11
- clj >= 1.10
- node >= 10.0.0
- npm >= 6.0.0
- docker >= 20.10.16
Once requirements have been installed you could build css styles:
```shell script
npm install
make css-dev
```
and run for starting dev server:
```shell script
make repl
```
inside repl session please run:
```shell script
(reset)
```
Now built and auto reloaded web app is available on: `http://localhost:8001`.
If you would like to change tailwindcss config or add some custom css
to `resources/public/css/styles.css` you could run building css in watch mode:
```shell script
make css-watch
```
### Linting and formatting
To perform lint and fmt actions we use `docker-compose` for all cases:
local checking and CI on every push to `dev` branch.
#### Linting
For first time or when some lib is added or updated you should run:
```shell
make lint-init
```
Then on regular basis please run:
```shell
make lint
```
#### Running tests
```shell
make test
```
#### Formatting
There are two options checking code formatting:
```shell
make fmt-check
```
and fixing (*change code!*):
```shell
make fmt
```