https://github.com/ammarnajjar/reading-todo

Manage my books reading todo list
https://github.com/ammarnajjar/reading-todo

ansible docker docker-compose educational helm kubernetes podman-compose postgersql prototype reactjs

Last synced: 3 months ago
JSON representation

Manage my books reading todo list

• Host: GitHub
• URL: https://github.com/ammarnajjar/reading-todo
• Owner: ammarnajjar
• License: mit
• Created: 2019-08-13T07:58:46.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-10T11:08:06.000Z (over 1 year ago)
• Last Synced: 2025-01-31T06:57:26.601Z (over 1 year ago)
• Topics: ansible, docker, docker-compose, educational, helm, kubernetes, podman-compose, postgersql, prototype, reactjs
• Language: TypeScript
• Homepage: https://reading-todo.herokuapp.com/
• Size: 2.6 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# reading-todo

[![Build](https://github.com/ammarnajjar/reading-todo/workflows/CI/badge.svg)](https://github.com/ammarnajjar/reading-todo/actions)

[![Deployment](https://github.com/ammarnajjar/reading-todo/workflows/CD/badge.svg)](https://reading-todo.herokuapp.com/)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/ammarnajjar/reading-todo.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ammarnajjar/reading-todo/alerts/)

[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ammarnajjar/reading-todo.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ammarnajjar/reading-todo/context:javascript)

[![Maintainability](https://api.codeclimate.com/v1/badges/793469291a411ffc446c/maintainability)](https://codeclimate.com/github/ammarnajjar/reading-todo/maintainability)

An app to manage a reading todo list

Releases are automatically deployed on [heroku](https://reading-todo.herokuapp.com/)

I am starting this maily for educational purposes.

For changes refer to [CHANGELOG.md](CHANGELOG.md)

  Development

### Build and Run

  

Ansible

  

https://docs.ansible.com/ansible/latest/user_guide/playbooks.html

This will create a python3 virtual environment and run ansible playbook inside of it.

```bash

ansible/play ansible/playbook.yml -i ansible/hosts.yml

```

  

docker-compose

  

https://docs.docker.com/compose/

```bash

docker-compose up --build

```

  

podman-compose

  

https://github.com/containers/podman-compose

```bash

sudo podman-compose up --build

```

  

tilt

  

https://tilt.dev/

- Deploy:

  ```bash

  tilt up --no-browser --hud=false --watch=false

  ```

- Access to client:

      ```bash

      kubectl port-forward deployment/client 3300:80

      ```

  

  

direnv

  

https://github.com/direnv/direnv

Source the `.envrc` file which adds some scripts to the `PATH`

```bash

ci        # => run ci pipeline

compose   # => docker-compose locally

cicd      # => run ci pipeline then compose

deploy    # => deploy to kubernetes locally

```

### Browse the deployment

- Client: [localhost:3100](http://localhost:3100/)

- Docs: [localhost:3200](http://localhost:3200/)

- Prod: [localhost:3300](http://localhost:3300/)