Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/arpan-206/discordly

appwrite discord discord-py fastapi hacktoberfest url-shortener

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/arpan-206/discordly
Owner: Arpan-206
License: mit
Created: 2022-10-18T05:58:37.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2022-10-23T07:48:56.000Z (about 2 years ago)
Last Synced: 2024-11-24T19:37:57.256Z (about 1 month ago)
Topics: appwrite, discord, discord-py, fastapi, hacktoberfest, url-shortener
Language: Python
Homepage:
Size: 960 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Discordly

![Discordly](static/DiscordlyThumbnail.png)

A Discord-bot to readily and easily shorten links from [Discord](https://discord.com) itself, made possible by [Appwrite](https://appwrite.io/).

## Installation

Install the project

```bash

  git clone https://github.com/Arpan-206/discordly.git

  cd discordly

```

    

## Environment Variables

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

- `DISCORD_BOT_TOKEN`

- `OWNER`

- `AW_PROJECT`

- `AW_ENDPOINT`

- `AW_KEY`

- `DEPLOY_URL`

- `AW_DB`

- `AW_LINKS_COLLECTION`

- `PORT`

## Deployment

To deploy this project run, after setting all the required environement variables.

```bash

  docker compose up -d

```

## Feedback

If you have any feedback, please reach out to us at [[email protected]](mailto:[email protected]).

## Authors

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

## License

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

## Screenshots

![1](static/screenshots/1.png)

![2](static/screenshots/2.png)

![3](static/screenshots/3.png)

![4](static/screenshots/4.png)

![5](static/screenshots/5.png)

![6](static/screenshots/6.png)

## Acknowledgements

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

 - [Discord](https://discord.com)

 - [FastAPI](https://fastapi.tiangolo.com)

## Contributing

Contributions are always welcome!

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

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