React ChatBotify Gallery API
Table of Contents
Introduction
The React ChatBotify Gallery is a new project introduced alongside v2 of React ChatBotify. The purpose of the gallery website is to provide developers with a central place for browsing, rating and sharing both themes and plugins. The website comes with an interactive theme preview feature, which allows developers to try out and visualise how the various themes look like. As an added bonus, the website also comes with a theme builder, which allows developers to directly craft and share themes by uploading them on the website. To support the functionality of the website, a robust backend is required - thus, this API project was created.
Note that this repository contains the code for the backend portion of the gallery project. The frontend code for the gallery project is separately maintained here.
Features
Apart from a handful of background jobs, the Gallery API largely supports requests from the frontend website to perform operations. Thus, the features of the API mirrors/complements those of the website.
For more information on what this project delivers, you may wish to check out the implementation section of the Developer Guide.
Technologies
Technologies used by React ChatBotify Gallery API are as below:
Done with:
NodeJS
Typescript
Project Repository
Team
// todo: the team will be expanded once members are confirmed
Contributing
If you are looking to contribute to the project, you may find the Developer Guide useful.
In general, the forking workflow is encouraged and you may open a pull request with clear descriptions on the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an issue or raising it up on discord.
Note: Templates have been created for pull requests and issues to guide you in the process.
Support
If there are any questions pertaining to the application itself (usage or implementation wise), you may create an issue, raise it up on discord, or drop me an email at: cjtanjin@gmail.com.