formerly yals.ml

| Visit | Report Bug | Request Feature |

Table Of Contents

• Table Of Contents
• Project Status
• About
• Built With
• Getting Started
  • Requirements
  • Installation
• Roadmap
• Contributing
  • Creating A Pull Request
• License
• Authors
• Roadmap
• Contributing
• License
• Authors

Project Status

About

There are tons of link shorteners present on internet today, however, they do not let you create custom link or they limit them till some extent, but turl(yals) will soon let you create custom branded links for free, until my Fauna database doesn't run out of space 😄

Here's why you should you turl:

• Most clear interface ever.
• No ads till now.
• 99.99% uptime.

Built With

• Nextjs
• Tailwaind CSS
• FaunaDB
• GraphQL

Deployed on

• Vercel

Getting Started

Here is how you can get started with the project locally

Requirements

• node
• npm or yarn (prefer yarn)

Installation

1. Clone the repo

   git clone https://github.com/SatvikG7/turl
   

2. Install NPM packages

   npm install
   # or
   yarn install
   

3. Create .env.local in root directory of project

4. Setup FaunaDb

   • Create FaunaDB database
   • Upload schema.gql in fauna db graphql tab
   • Upload shell.fql to fauna db shell tab

5. Enter your API keys in .env.local

NODE_ENV=development
BASE_URL=http://localhost:3000
FAUNADB_SECRET=<FAUNADB_SECRET>

# Optional if you want to generate sitemap

VERCEL_API_URL=https://api.vercel.com/v6/deployments?teamId=<YOUR_TEAM_ID_OR_USERNAME>
VERCEL_API_TOKEN=<VERCEL_API_TOKEN>

6. Start dev server

npm run dev
# or
yarn dev

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing features, feel free to open an issue to discuss it, or directly create a pull request with necessary changes.
• Create individual PR for each suggestion.

Creating A Pull Request

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 for more information.

Authors

• Satvik Gaikwad - Satvik Gaikwad