https://github.com/thomas-crane/aphid

A Discord library built for TypeScript. 🌱🦗
https://github.com/thomas-crane/aphid

discord discord-js library typescript

Last synced: about 1 month ago
JSON representation

A Discord library built for TypeScript. 🌱🦗

• Host: GitHub
• URL: https://github.com/thomas-crane/aphid
• Owner: thomas-crane
• License: mit
• Created: 2019-03-05T12:00:57.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-15T02:22:40.000Z (over 5 years ago)
• Last Synced: 2024-10-12T11:10:53.560Z (2 months ago)
• Topics: discord, discord-js, library, typescript
• Size: 91.8 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# Aphid

A Discord library built for TypeScript. 🌱🦗

## Contents

+ [Aphid](#aphid)

+ [Contents](#contents)

+ [About](#about)

+ [Early development](#early-development)

+ [Acknowledgements](#acknowledgements)

## About

Aphid is a work in progress Discord library which was designed with TypeScript in mind.

You can read about what Aphid hopes to be in the [spec document.](docs/spec.md) It outlines the design and provides examples of the planned API of the project.

## Early development

Aphid is far from functional. In fact, *it doesn't even have any TypeScript code yet.*

Before any code is written, the documents in the `docs/` folder (particularly `spec.md`) will be continuously refined. While this project is still in its specification phase, your contributions are extremely valuable!

Now is the best time to request changes, suggest new ideas, or request the deletion of a feature. These kind of changes can be discussed via an issue or a pull request, and implemented into the spec without any actual code changes. This means that you don't need to wait for code and tests to be written, and you won't need to wait for the next major release to see breaking changes implemented.

If you feel like contributing to this project in its early phases, have a read of the current [specification!](docs/spec.md)

The provided [example](docs/example.md) is a good resource to get a feel for how the spec translates into a real world project.

## Acknowledgements

The way this library works is heavily inspired by how [Angular](https://angular.io/) works.

It also uses [Discord.js](https://discord.js.org/) as a base.