EC URL Store 🔗

Welcome to URL Store project! This repository is designed to help you manage and store URLs efficiently.

Table of Contents

• EC URL Store 🔗
  • Table of Contents
  • Introduction 🙌
  • Features 🚀
  • Installation 🛠️
  • Usage 📝
  • Contributing 🤝
  • License 📝

Introduction 🙌

The URL Store project is a simple and lightweight tool that allows you to store and manage URLs. It provides an easy-to-use interface for adding new URLs and retrieving stored URLs. The project is open-source and free to use, and it is actively maintained and updated by the Engineers Cradle team.

Features 🚀

• Add new URLs
• Retrieve stored URLs
• Simple and intuitive interface
• Lightweight and easy to use
• Open-source and free to use
• Actively maintained and updated
• gRPC-based API for IP tracking
• RESTful API for URL management
• Analytics for tracking URL usage

Installation 🛠️

To install the project, clone the repository and install the necessary dependencies:

git clone https://github.com/Engineers-Cradle/ec-url-store.git
cd ec-url-store
pnpm install
pnpm build:release

Usage 📝

To start using the URL store, run the following command:

• Check crates/api and crates/geo-ip packages and fill in the .env files with the necessary values (check the .env.example files for reference).
• Run the following command to start the URL store:

pnpm start

You can then interact with the URL store through the provided interface.

Contributing 🤝

We welcome contributions to the Engineers Cradle URL Store project. To contribute, please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature-branch)
3. Commit your changes (git commit -m 'Add new feature')
4. Push to the branch (git push origin feature-branch)
5. Create a Pull Request

License 📝

This project is licensed under the MIT License. See the LICENSE file for more details.