[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![logo](https://raw.githubusercontent.com/origranot/reduced.to/ec59ee1dfe4c858b89d2d22935e2734d52794ea3/frontend/public/logo.svg)](https://reduced.to)
[![Preview](/assets/images/preview.gif)](https://reduced.to)
Reduced.to is a modern web application that reduces the length of link URL. So it's easier to remember, share and track.
App
ยท
Report Bug
ยท
Request Feature
๐ Table of Contents
-
๐ About The Project
-
๐ Getting Started
- ๐ฑโ๐ป Usage
- ๐งฑ Roadmap
- ๐ฅ Contributing
- ๐ Contributors
- ๐ License
- ๐ Contact
๐ About The Project
๐ฅ Built With
List of frameworks/libraries used to bootstrap the project.
(back to top)
๐ Getting Started
๐ Prerequisites
List of things you need to run the project locally and how to install them.
๐ป Installation
- Fork / Clone this repository
- Install NPM packages
npm install
- Copy
.example.env
to .env
and fill it properly (see Configuration)
- Make sure you have a local instance of PostgreSQL running on port 5432. If not, you can run it using docker:
docker run --name reduced_to_db -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=reduced_to_db -p 5432:5432 -d postgres
- Run Prisma migration from root folder:
npx nx migrate-dev prisma --name=init
- Run the backend from root folder:
npx nx serve backend
- Run the frontend from root folder:
npx nx serve frontend
๐ฉโ๐ป Development
The project is structured in the following way:
.
โโโ apps/
โ โโโ backend
โ โโโ frontend
โโโ libs/
โโโ config
โโโ prisma
๐ณ Docker
You can build the docker images by running the following nx command:
npx nx run-many -t docker-build
- This command will automatically build the dependencies and the backend and frontend images.
๐ Docker compose
- In case you have docker installed, you can single-click deploy and test your changes by running the following and going to
http://localhost:5000/
on your browser.
-
When you run the command below, don't forget to change the .env file with the correct values.
docker compose -f docker/local/docker-compose.yml -p reduced-to up
โธ Deployment
You can deploy the app to a Kubernetes cluster by installing the Helm chart.
- Navigate to the
chart
directory (/docker/k8s/chart)
- Update the values in the
values.yaml
file
- Run the following command to deploy the app to your cluster:
helm install reduced-to . --namespace reduced-to --create-namespace
๐ท Configuration
For the minimal configuration you can just rename the .example.env
files to .env
.
General
- BACKEND_APP_PORT: Backend port
- FRONTEND_APP_PORT: Frontend port
- NODE_ENV: Node environment (development / production)
Database
- DATABASE_URL: Database connection string
Rate Limit
- RATE_LIMIT_TTL: Rate limit TTL (time to live)
- RATE_LIMIT_COUNT: Number of requests within the ttl
- PADDLE_ENABLE: Wethter to enable Paddle or not
- PADDLE_WEBHOOK_KEY: Get it from your Paddle account
- PADDLE_SECRET_KEY: Get it from your Paddle account
Logger
- LOGGER_CONSOLE_THRESHOLD: Threshold level of the console transporter.
Frontend
- DOMAIN: Domain of your frontend app
- PUBLIC_PADDLE_KEY: Get it from your Paddle account (Not needed when running locally)
- API_DOMAIN: Domain of your backend instance (used for server side requests)
- CLIENTSIDE_API_DOMAIN: Domain of your backend instance (used for client side requests)
- STORAGE_DOMAIN=Domain of your bucket (used for storing images)
Redis
- REDIS_ENABLE: Whether to use external Redis store or not
- REDIS_HOST: Redis instance host
- REDIS_PORT: Redis instance port
- REDIS_PASSWORD: Redis instance password
- REDIS_TTL: Redis ttl (in seconds)
Auth
- JWT_ACCESS_SECRET: Jwt secret (used for access tokens)
- JWT_REFRESH_SECRET: Jwt secret (used for refresh tokens)
Safe Browsing API
Novu
- NOVU_API_KEY: Get it from https://novu.co/, you don't need this when running locally (just verify your email from the database)
Happy Hacking !
Change my plan on development
If you want to change your plan on developemnt (Assuming you have a local instance of PostgreSQL running on port 5432 and you don't have Paddle configured):
- Register locally on the app.
- Go to your database and create a new row in the
Subscription
table:
id
: 1
userId
: (you can find your user id in the User
table)
plan
: (FREE / PRO / BUSINESS)
status
: active
endDate
: Choose a date in the future
scheduledToBeCancelled
: false
endDate
: empty (NULL)
nextBilledAt
: empty (NULL)
createdAt
: current date
updatedAt
: current date
- Relogin to the app (refresh the JWT token)
- You can now access the premium features.
(back to top)
๐ฑโ๐ป Usage
Simply copy and paste a URL into the provided area. Then click shorten URL! Your URL has now been shortened!
(back to top)
๐งฑ Roadmap
- [x] Migrate backend to NestJS
- [x] Migrate frontend to Qwik
- [x] Better README
- [x] Generate QRCode
- [x] Split front-end into components
- [x] Better UI
- [x] Animations
- [x] Logo
- [x] Dark/Light mode
- [ ] Improve front-end components
- [x] Backend tests
- [x] Migration to Nx
- [ ] Split backend into libs
- [ ] Support k8s deployment (helm)
- [ ] Front-end Tests
- [ ] Logs
- [ ] Add a statistics page
- [ ] Add more ideas
Just create a Pull request already ๐
See the open issues for a full list of proposed features (and known issues).
(back to top)
๐ฅ Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star โญ!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
)
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
)
- Push to the Branch (
git push origin feature/AmazingFeature
)
- Open a Pull Request
๐ Contributors
(back to top)
๐ License
This project is licensed under the terms of the MIT License
(back to top)
๐ Contact
Project Link: https://github.com/origranot/reduced.to
(back to top)