README.md

EddieBotUI

Eddie Jaoude's Discord bot web application.
Report Bug · Request Feature

Table of Contents

• About EddieBotUI
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Contributors
• CoC
• License

About EddieBotUI

EddieBotUI is a web application built to display all kinds of information about the EddieHub Discord community - click to join - like users biography, usage stats, badges and more.

Getting Started

Before diving in the getting started, there are couple of prerequisites: make sure to satisfy all of them before proceeding. At the end of this section you will be able to run EddieBotUI on your machine.

Prerequisites

Since this is a React-based project, ensure to have installed NodeJS and npm. Here you find some useful links:

• Node
• npm

Of course, you will also need GIT.

Once you have these things installed on your machine, you're ready for the next step.

Installation

1. Clone the project repository

// With SSH
git clone [email protected]:EddieJaoudeCommunity/EddieBotUI.git

// With HTTPS
git clone https://github.com/EddieJaoudeCommunity/EddieBotUI.git

2. Install dependencies

npm i

3. Run the application

npm start

You should see the application running on http://localhost:3000/ 🚀

Contributing

See CONTRIBUTING for more information.

Contributors

See the list of contributors involved in this project.

CoC

Check out our Code of Conduct.

License

Distributed under the MIT License. See LICENSE for more information.