# README
Respire API Go
Our project, "respire.", aims to address the issue of smoking addiction by fostering a collaborative and supportive environment around users. Recognizing that quitting smoking is a challenging endeavor that benefits greatly from encouragement and accountability, our project leverages the power of community and technology to create a unique support system for its users.
This repository is a backend app for our android app.
Table of Contents
- Respire API Go
Link to the Mobile app's source code:
https://github.com/aidanakalimbekova/respire-mobile
Link to the AI assistant backend service
https://github.com/Brainsoft-Raxat/respire-ai-assistant-api-py
Overview
Demo Video
Youtube Video Link: https://www.youtube.com/watch?v=XZaXcsDsGV4
Technologies
UN Sustainable Development Goals And Targets
Core functionalities
Smoking Habbits Tracker
Social Networking and Engaging in Cooperative Challenges
Personalized AI Generated Daily Recommendations to Cope with Cravings
Installation
Prerequisites
- Go (version 1.21.4)
Clone the repository
git clone https://github.com/Brainsoft-Raxat/respire-api-go.git
cd repository
Install dependencies
go get ./...
Usage
Build and run the application
go build ./cmd/app/main.go -o app .
./app
By default, the application will run on localhost:8080.
Configuration
- Edit config.yaml according to your configs.
- When local development set env to 'local' and host to localhost.
- Feel free to set any port you want.
- Download Firebase SDK JSON configuration and put it into project root directory. In our case file is named as "quitsmoke-20141-firebase-adminsdk-ugo14-c5730ea21d.json"
Swagger documentation
https://respire-api-go-jc4tvs5hja-ey.a.run.app/swagger//index.html#/users/get_user_search