Table of Contents
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
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:
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
The things you need to install the software and how to install them
- Golang
- npm
npm install npm@latest -g
- Clone the repo
git clone https://github.com/labadcloyd/habitlux.git
- Change directory to the server
cd server
- Run the main.go file
go run main.go
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:
-
Setup a test postgres server on your local machine. Read Here
-
Create a .env file following the format of the sample.env file and input the necessary variables.
-
Open a cmd terminal and change directory to the server directory
-
Finally, run the test while disabling the default parallel behavior:
go test -p 1 ./...
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Cloyd Abad - Linkedin
Project Link: https://github.com/labadcloyd/habitlux