NASTAPP-API

API for Nastapp, an app that keeps track of the prices of gas for several gas stations across a region.

---

📖 Table of Contents

• 📖 Table of Contents
• 📍 Overview
• 📦 Features
• 📂 Repository Structure
• ⚙️ Modules
• 🚀 Getting Started
  • 🔧 Installation
  • 🤖 Running nastapp-api
  • 🧪 Tests
• 🛣 Project Roadmap
• 🤝 Contributing
  • Contributing Guidelines
• 📄 License
• 👏 Acknowledgments

---

📍 Overview

► [WIP]

---

📦 Features

► Get gas stations near a point at certain maximum distance

---

📂 Repository Structure

└── nastapp-api/
    ├── .tool-versions
    ├── TODOS
    ├── db/
    │   ├── db_repository.go
    │   ├── lat_long.go
    │   ├── mongo_client.go
    │   └── places_result.go
    ├── go.mod
    ├── go.sum
    ├── main.go
    └── router/
        ├── api_error.go
        ├── handlers.go
        ├── router_setup.go
        └── swagger_setup.go

---

⚙️ Modules

Db

File	Summary
mongo_client.go	► INSERT-TEXT
db_repository.go	► INSERT-TEXT

Router

File	Summary
handlers.go	► INSERT-TEXT
router_setup.go	► INSERT-TEXT
swagger_setup.go	► INSERT-TEXT

---

🚀 Getting Started

Dependencies

- ℹ️ Go 1.21.3

🔧 Installation

Clone and install dependencies:

git clone https://github.com/juampiq6/nastapp-api
cd nastapp-api
go get

🤖 Running nastapp-api

go run *.go

🧪 Tests

go test

---

🛣 Project Roadmap

See TODOS file

• ℹ️ Task 1: Implement X
• ℹ️ Task 2: Implement Y
• ℹ️ ...

---

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.
• Report Issues: Submit bugs found or log feature requests for JUAMPIQ6.

Contributing Guidelines

Click to expand

1. Fork the Repository: Start by forking the project repository to your GitHub account.
2. Clone Locally: Clone the forked repository to your local machine using a Git client.

   git clone <your-forked-repo-url>

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear and concise message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.

---

📄 License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.

---

👏 Acknowledgments

• List any resources, contributors, inspiration, etc. here.

Return to top

---