Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/engineers-cradle/ec-url-store
A Url Shortener microservice build with Rust
https://github.com/engineers-cradle/ec-url-store
grpc hacktoberfest ip mmdb postgresql rust
Last synced: 9 days ago
JSON representation
A Url Shortener microservice build with Rust
- Host: GitHub
- URL: https://github.com/engineers-cradle/ec-url-store
- Owner: Engineers-Cradle
- License: mit
- Created: 2024-09-26T21:58:52.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T20:25:21.000Z (12 days ago)
- Last Synced: 2024-12-10T21:25:19.608Z (12 days ago)
- Topics: grpc, hacktoberfest, ip, mmdb, postgresql, rust
- Language: Rust
- Homepage:
- Size: 146 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# 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 🔗](#ec-url-store-)
- [Table of Contents](#table-of-contents)
- [Introduction 🙌](#introduction-)
- [Features 🚀](#features-)
- [Installation 🛠️](#installation-️)
- [Usage 📝](#usage-)
- [Contributing 🤝](#contributing-)
- [License 📝](#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:
```bash
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:
```bash
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](LICENSE) file for more details.