Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/Arpan-206/app-ly

appwrite hacktoberfest

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/Arpan-206/app-ly
Owner: Arpan-206
License: mit
Created: 2022-10-05T04:17:40.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2022-10-16T16:10:01.000Z (almost 2 years ago)
Last Synced: 2024-06-07T08:33:51.434Z (3 months ago)
Topics: appwrite, hacktoberfest
Language: Svelte
Homepage:
Size: 5.49 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-appwrite - Source Code

README

        # App-ly

![App-ly Thumbnail](static/App-ly.png)

App-ly is an open-source URL shortener made using Svelte and Appwrite. It is a web app that allows you to shorten long URLs, share them, and generate QR Codes for them. 

## Acknowledgements

 - [Appwrite](https://appwrite.io/)

 - [PicoCSS](https://picocss.com/)

 - [Svelte](https://svelte.dev/)

## Authors

- [@Arpan-206](https://www.github.com/Arpan-206)

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Run Locally

#### Clone the project

```bash

  git clone https://github.com/Arpan-206/app-ly.git

```

#### Go to the project directory

```bash

  cd app-ly

```

#### Install dependencies

```bash

  npm install

```

or 

```bash

  yarn install

```

#### Start the development server

```bash

  npm run dev

```

or 

```bash

  yarn run dev

```

#### Build for production

```bash

  yarn run build

```

or 

```bash

  npm run build

```

#### Preview production build

```bash

  npm run preview

```

or

```bash

  yarn run preview

```

## Environment Variables

To run this project, you will need to add the following environment variables to your .env file

`PUBLIC_AW_PROJECT`

`PUBLIC_AW_ENDPOINT`

`PUBLIC_AW_DB`

`PUBLIC_AW_ANON_COLLECTION`

`PUBLIC_AW_LOGIN_COLLECTION`

## Roadmap

- Link Groups

- Profile Links

- Bulk Redirects

## Screenshots

![1](screenshots/1.png)

![2](screenshots/2.png)

![3](screenshots/3.png)

![4](screenshots/4.png)

![5](screenshots/5.png)

![6](screenshots/6.png)

![7](screenshots/7.png)

![8](screenshots/8.png)

## Contributing

Contributions are always welcome!

See `contributing.md` for ways to get started.

Please adhere to this project's `code of conduct`.

## Support

For support, email [[email protected]](mailto:[email protected]).