https://github.com/adiologydev/breve
A Simple Link Shortening Service
https://github.com/adiologydev/breve
hacktoberfest
Last synced: over 1 year ago
JSON representation
A Simple Link Shortening Service
- Host: GitHub
- URL: https://github.com/adiologydev/breve
- Owner: adiologydev
- License: other
- Created: 2022-01-10T09:46:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T08:28:54.000Z (over 3 years ago)
- Last Synced: 2025-01-21T15:50:53.095Z (over 1 year ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 305 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Breve
A Simple Link Shortening Service
## Getting Started
### 1. Clone the repository
```bash
git clone https://github.com/AdityaTD/Breve.git
```
### 2. Install dependencies
```bash
cd Breve
npm install
```
### 3. Fill in the environment variables
```bash
cp .env.example .env
```
Edit the `.env` file and enter your variables.
### 4. Start the server
```bash
npm start
```
## License
Breve is licensed under the [Apache 2.0 License](https://github.com/AdityaTD/Breve/blob/main/LICENSE)