https://github.com/2kabhishek/web-rewrite
Rewrite you URLs 🌏✏️
https://github.com/2kabhishek/web-rewrite
appwrite express nodejs utility
Last synced: 2 months ago
JSON representation
Rewrite you URLs 🌏✏️
- Host: GitHub
- URL: https://github.com/2kabhishek/web-rewrite
- Owner: 2KAbhishek
- License: apache-2.0
- Created: 2022-05-12T21:01:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T07:21:00.000Z (over 1 year ago)
- Last Synced: 2025-03-11T08:26:17.111Z (over 1 year ago)
- Topics: appwrite, express, nodejs, utility
- Language: JavaScript
- Homepage:
- Size: 179 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## What is this
web-rewrite is a utility that allows you to rewrite your URLs.
## Inspiration
I wanted to write my own url shortener and then came accross appwrite, which motivated me enough to do it.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of `node`, `appwrite`
- web-rewrite needs the following env vars to function correctly
```bash
HOST=appwrite-console-host
APPWRITE_PORT=80 #Port where appwrite console is running
PROJECT_ID=project-id-from-appwrite-console
API_KEY=api-key-from-appwrite-console
APP_PORT=4321 # The port where you want web-rewrite to run
LINKS_COLLECTION_ID=links-collection-id1 #Try changing this if setup fails
```
## Getting web-rewrite
To install web-rewrite, follow these steps:
```bash
git clone https://github.com/2kabhishek/web-rewrite
cd web-rewrite
touch .env
npm run setup # Sets up the links collection in appwrite
npm start
```
## Using web-rewrite
After starting the app you can visit the app through your browser.
## How it was built
web-rewrite was built using `node`, `express` and `appwrite`
## Challenges faced
While building web-rewrite the main challenges were:
- Setting up AppWrite collections through node was tricky
## What I learned
- AppWrite and it's different services, will use it more in upcoming projects
- Web routing
## What's next
May deploy it somewhere soon
### To-Do
- [ ] Deploy web-rewrite
Hit the ⭐ button if you found this useful.
## More Info
- [AppWrite](https://appwrite.io)
