ZEZ

An Open Source Free Custom URL Shortener
Explore the docs »

Report Bug · Request Feature

About The Project

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• NextJS 13.4 /app dir
• Tailwind CSS for styling
• Upstash Redis for storing public url and expiration
• Mongo Atlas for save URL for SignIn user
• Next Auth for User Authentication
• Prisma for ORM
• Zustand for state management
• Radix-UI for easier UI Components
• qr-code-styling package for QR-Code Generation
• Deployment with Vercel

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/raymondtju/zez.git

2. Install NPM packages

   npm install

3. Create .env file based on .env.example

   DATABASE_URL=
   NEXT_PUBLIC_BASE_URL=http://localhost:3000
   NEXT_PUBLIC_GUEST_TOKEN= 
   
   NEXTAUTH_URL=http://localhost:3000
   NEXTAUTH_SECRET=
   
   GOOGLE_CLIENT_ID=
   GOOGLE_CLIENT_SECRET=
   
   UPSTASH_REDIS_REST_URL=
   UPSTASH_REDIS_REST_TOKEN=

Roadmap

• Add QR Code
• Configure Custom Metatags title and description
• Configure Custom Metatags Image
• Making UI more beautiful
• Adding some section into homepage
• Optimized Performance

See the open issues for a full list of proposed features (and known issues).

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! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - @raymondtju_ - [email protected]

Project Link: https://github.com/raymondtju/zez

(back to top)