Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kuuuuuuuu/wind

a simple URL shortener written in TypeScript with Express.js and MySQL2.
https://github.com/kuuuuuuuu/wind

ejs express express-js expressjs link-shortener mysql mysql-database mysql2 nodejs typescript

Last synced: about 1 month ago
JSON representation

a simple URL shortener written in TypeScript with Express.js and MySQL2.

Awesome Lists containing this project

README

        

# Wind 🍃

Wind is a simple url shortener written in TypeScript with Express.js and MySQL2.

### Requirements :warning:

- Node.js (LTS or latest)
- MySQL Database

### Setup :gear:

1. **Clone the Repository**

```
git clone https://github.com/Kuuuuuuuu/Wind.git
```

2. **Install Dependencies**

```bash
npm install
```

3. **Configure Environment**

- Rename `.env.example` to `.env`
- Fill in your database information in the `.env` file

4. **Start the Application**

```bash
npm start
```

5. **Enjoy!** :D :sparkles:

Feel free to contribute! If you encounter any issues, please submit them on [GitHub Issues](https://github.com/Kuuuuuuuu/Wind/issues). Your feedback and contributions are highly appreciated.