acmpesuecc / ArcList

A To-do app built with Go + HTMX
MIT License
0 stars 22 forks source link
hacknight-2024 hacktoberfest

ArcList ᚬᚱᚴᛚᛁᛋᛏ

ArcList is a minimalist, intuitive to-do app built with Go and HTMX. The app's primary purpose is to explore and showcase the potential of HTMX for seamless, modern front-end interactivity, paired with Go's robust back-end capabilities.

Features

Setting up the Project and Contributing to the Project

Prerequisites

To setup the project locally follow the steps:

  1. Fork the project.
  2. Clone your forked repository onto your local machine.

    git clone https://github.com/<YOUR-GITHUB-USERNAME>/ArcList.git
  3. Add the upstream repository

    cd ArcList
    git remote add upstream https://github.com/acmpesuecc/ArcList.git
    git pull upstream main
  4. Add a new branch ( THIS STEP IS OPTIONAL and you can continue to work on the main branch )

    git checkout -b <NEW-BRANCH-NAME>
  5. Now to Run the application, Go to the repository root directory

    go run main.go

[!NOTE]
It might ask for permission, please 'Allow'

  1. Naviagte to http://localhost:8080/

  2. After making changes to your codebase, stage and push the code to your forked repo

    git add <\files_that_you_made_changes>
    git commit -m "<COMMIT-MESSAGE>"
    git push -u origin <BRANCH-NAME>
  3. Finally have Fun 😃 and Happy Contributing !! 🥳