https://github.com/victor101106/linkyn
Fast and account-free URL Shortener API, just shorten a link and generate a token to manage!
https://github.com/victor101106/linkyn
api api-rest api-restful clean-arch clean-architecture lightweight nodejs nodejs-api stateless token-based token-based-authentication typescript url url-shortener
Last synced: 7 months ago
JSON representation
Fast and account-free URL Shortener API, just shorten a link and generate a token to manage!
- Host: GitHub
- URL: https://github.com/victor101106/linkyn
- Owner: Victor101106
- License: gpl-3.0
- Created: 2025-02-25T18:14:05.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-26T18:26:04.000Z (7 months ago)
- Last Synced: 2025-02-26T18:43:40.968Z (7 months ago)
- Topics: api, api-rest, api-restful, clean-arch, clean-architecture, lightweight, nodejs, nodejs-api, stateless, token-based, token-based-authentication, typescript, url, url-shortener
- Language: TypeScript
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Linkly
Fast and account-free URL Shortener API, just shorten a link and generate a token to manage!
## Content Table
- [Requirements](#requirements)
- [Getting Started](#getting-started)
- [Environment Variables](#environment-variables)
- [Conventional Commits](#conventional-commits)
- [License](#license)
- [Contact](#contact)
## Requirements
- `NodeJS v20.x`
- `npm v10.x`
- `Docker >= v28.0.0`
## Getting Started
Follow the step-by-step instructions to set up and run the project:
1. Clone the repository:
```bash
git clone https://github.com/Victor101106/Linkyn.git
```
2. Install dependencies:
```bash
npm install
```
3. Configure environment variables:
- Copy `.env.example` file and rename it to `.env`:
```bash
cp .env.example .env
```
- Update the `.env` file with the required values. Refer to the [Environment Variables](#environment-variables) for details.
4. Run the project in development mode:
```bash
npm run start:dev
```
## Environment Variables
To run the project correctly, you must set the required environment variables. Create a `.env` file in the root directory based on the `.env.example` file. Below is a description of the required variables:
| Variable | Description | Example Value |
|----------|---------------------------------------|---------------|
| `PORT` | The port where the server will listen | `3030` |
## Conventional Commits
This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification to maintain a clean and consistent commit history.
### Commitizen: How to Use
1. Stage your changes:
```bash
git add [...]
```
2. Commit using `Commitizen`:
```bash
npm run git:commit
```
3. Follow the interactive prompts.
`Commitizen` will guide you through crafting a proper commit message.
### Message Structure
The commit message should be structured as follows:
```bash
[optional scope]:
[optional body]
[optional footer(s)]
```
#### Example:
```bash
feat(auth): add login functionality
```
## License
Distributed under the GPL v3.0 license. See [LICENSE](LICENSE.md) for more information.
## Contact
Victor Gabriel • [Github](https://github.com/Victor101106/) • victorgabriel101106+github@gmail.com