Skip to content

A habit tracking app that has the server built with Go, Fiber, and Postgres and the client built with React, and Next.

License

Notifications You must be signed in to change notification settings

labadcloyd/habitlux

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Logo

Habitlux

Build up your habits!
View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Habitlux Screen Shot

I've been trying to build up some habits and turn my life around one step at a time. At one point I found myself trying to list the habits down in a note book. It was tedious, dirty, and took too much effort. Then I came to a realization that I'm a software developer and I can build a way to make this more efficient. So, I created Habitlux, a web app that makes it more efficient to track your habits using any mobile or desktop device.

Of course, the app still has a lot more to improve, so if you have any feature request, please feel free to open an issue here

(back to top)

Built With

The project's frontend was created with the following libraries and technologies:

And the project's backend was created with the following libraries and technologies:

(back to top)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

The things you need to install the software and how to install them

  • Golang
  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/labadcloyd/habitlux.git
  2. Change directory to the server
    cd server
  3. Run the main.go file
    go run main.go

(back to top)

Running the API tests

The tests written for the API are integration tests and by default go test runs in parallel. This would be a nightmare for running integration tests. Follow the steps below:

  1. Setup a test postgres server on your local machine. Read Here

  2. Create a .env file following the format of the sample.env file and input the necessary variables.

  3. Open a cmd terminal and change directory to the server directory

  4. Finally, run the test while disabling the default parallel behavior:

     go test -p 1 ./...

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Cloyd Abad - Linkedin

Project Link: https://github.com/labadcloyd/habitlux

(back to top)

About

A habit tracking app that has the server built with Go, Fiber, and Postgres and the client built with React, and Next.

Topics

Resources

License

Stars

Watchers

Forks