https://github.com/flagarde/projecttemplate2
Template for C++ projects
https://github.com/flagarde/projecttemplate2
allcontributors appveyor-api breathe clang-format cmake cmake-format codecov cpp doxygen github-action github-actions github-pages project project-template sphinx template-project travis-ci
Last synced: 27 days ago
JSON representation
Template for C++ projects
- Host: GitHub
- URL: https://github.com/flagarde/projecttemplate2
- Owner: flagarde
- License: mit
- Created: 2020-08-05T11:58:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T20:57:48.000Z (almost 2 years ago)
- Last Synced: 2025-02-27T01:52:50.002Z (over 1 year ago)
- Topics: allcontributors, appveyor-api, breathe, clang-format, cmake, cmake-format, codecov, cpp, doxygen, github-action, github-actions, github-pages, project, project-template, sphinx, template-project, travis-ci
- Language: CMake
- Homepage: https://flagarde.github.io/ProjectTemplate2/
- Size: 5.83 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Bot Name
[]()
[](https://www.reddit.com/user/Wordbook_Bot)
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[](/LICENSE)
---
🤖 Few lines describing what your bot does.
## 📝 Table of Contents
+ [About](#about)
+ [Demo / Working](#demo)
+ [How it works](#working)
+ [Usage](#usage)
+ [Getting Started](#getting_started)
+ [Deploying your own bot](#deployment)
+ [Built Using](#built_using)
+ [TODO](TODO.md)
+ [Contributing](CONTRIBUTING.md)
+ [Contributors](CONTRIBUTORS.md)
+ [Authors](#authors)
+ [Acknowledgments](#acknowledgement)
## 🧐 About
Write about 1-2 paragraphs describing the purpose of your bot.
## 🎥 Demo / Working
The bot first extracts the word from the comment and then fetches word definitions, part of speech, example and source from the Oxford Dictionary API.
If the word does not exist in the Oxford Dictionary, the Oxford API then returns a 404 response upon which the bot then tries to fetch results form the Urban Dictionary API.
The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server.
The entire bot is written in Python 3.6
To use the bot, type:
```
!dict word
```
The first part, i.e. "!dict" **is not** case sensitive.
The bot will then give you the Oxford Dictionary (or Urban Dictionary; if the word does not exist in the Oxford Dictionary) definition of the word as a comment reply.
### Example:
> !dict what is love
**Definition:**
Baby, dont hurt me~
Dont hurt me~ no more.
**Example:**
Dude1: Bruh, what is love?
Dude2: Baby, dont hurt me, dont hurt me- no more!
Dude1: dafuq?
**Source:** https://www.urbandictionary.com/define.php?term=what%20is%20love
---
Beep boop. I am a bot. If there are any issues, contact my [Master](https://www.reddit.com/message/compose/?to=PositivePlayer1&subject=/u/Wordbook_Bot)
Want to make a similar reddit bot? Check out: [GitHub](https://github.com/kylelobo/Reddit-Bot)
## 🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo.
## 🚀 Deploying your own bot
To see an example project on how to deploy your bot, please see my own configuration:
+ **Heroku**: https://github.com/kylelobo/Reddit-Bot#deploying_the_bot
## ⛏️ Built Using
+ [PRAW](https://praw.readthedocs.io/en/latest/) - Python Reddit API Wrapper
+ [Heroku](https://www.heroku.com/) - SaaS hosting platform
## ✍️ Authors
+ [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors) who participated in this project.
## 🎉 Acknowledgements
+ Hat tip to anyone whose code was used
+ Inspiration
+ References
Project Title
[](http://hackathon.url.com)
[]()
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[](LICENSE.md)
---
Few lines describing your project.
## 📝 Table of Contents
- [Problem Statement](#problem_statement)
- [Idea / Solution](#idea)
- [Dependencies / Limitations](#limitations)
- [Future Scope](#future_scope)
- [Setting up a local environment](#getting_started)
- [Usage](#usage)
- [Technology Stack](#tech_stack)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgments)
## 🧐 Problem Statement
It is useful to design and follow a specific format when writing a problem statement. While there are several options
for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain
focus on defining the problem.
- IDEAL: This section is used to describe the desired or “to be” state of the process or product. At large, this section
should illustrate what the expected environment would look like once the solution is implemented.
- REALITY: This section is used to describe the current or “as is” state of the process or product.
- CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon.
This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth.
Following this format will result in a workable document that can be used to understand the problem and elicit
requirements that will lead to a winning solution.
## 💡 Idea / Solution
This section is used to describe potential solutions.
Once the ideal, reality, and consequences sections have been
completed, and understood, it becomes easier to provide a solution for solving the problem.
## ⛓️ Dependencies / Limitations
- What are the dependencies of your project?
- Describe each limitation in detailed but concise terms
- Explain why each limitation exists
- Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire.
- Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if
appropriate, describe how these limitations could point to the need for further research.
## 🚀 Future Scope
Write about what you could not develop during the course of the Hackathon; and about what your project can achieve
in the future.
## 🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development
and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them.
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
## 🎈 Usage
Add notes about how to use the system.
## ⛏️ Built With
- [MongoDB](https://www.mongodb.com/) - Database
- [Express](https://expressjs.com/) - Server Framework
- [VueJs](https://vuejs.org/) - Web Framework
- [NodeJs](https://nodejs.org/en/) - Server Environment
## ✍️ Authors
- [@kylelobo](https://github.com/kylelobo) - Idea & Initial work
See also the list of [contributors](https://github.com/kylelobo/The-Documentation-Compendium/contributors)
who participated in this project.
## 🎉 Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- References
# ProjectTemplate v0.2            #
# ProjectTemplate v0.2            #
## Template for C++ projects ##
[📘 Documentation](https://flagarde.github.io/ProjectTemplate/)
## Builds ##
| | Linux clang | Linux gcc | macOS clang | Windows MSVC | Windows MinGW |
|:-----------------:|:-----------------:|:-----------------:|:-----------------:|:-----------------:|:-----------------:|
|Github |![1] |![2] |![3] |![4] |![5] |
|Travis |[![6]][0] |[![7]][0] |[![8]][0] |[![9]][0] | ❌ |
[](https://app.codacy.com/manual/flagarde/ProjectTemplate?utm_source=github.com&utm_medium=referral&utm_content=flagarde/ProjectTemplate&utm_campaign=Badge_Grade_Dashboard)
[](https://www.codefactor.io/repository/github/flagarde/ProjectTemplate)
[](https://codecov.io/gh/flagarde/ProjectTemplate)
[1]: https://img.shields.io/github/workflow/status/flagarde/ProjectTemplate/Linux%20Clang
[2]: https://img.shields.io/github/workflow/status/flagarde/ProjectTemplate/Linux%20GCC
[3]: https://img.shields.io/github/workflow/status/flagarde/ProjectTemplate/macOS
[4]: https://img.shields.io/github/workflow/status/flagarde/ProjectTemplate/Windows%20MSVC
[5]: https://img.shields.io/github/workflow/status/flagarde/ProjectTemplate/Windows%20MinGW
[6]: https://travis-matrix-badges.herokuapp.com/repos/flagarde/ProjectTemplate/branches/master/1?use_travis_com=true
[7]: https://travis-matrix-badges.herokuapp.com/repos/flagarde/ProjectTemplate/branches/master/2?use_travis_com=true
[8]: https://travis-matrix-badges.herokuapp.com/repos/flagarde/ProjectTemplate/branches/master/3?use_travis_com=true
[9]: https://travis-matrix-badges.herokuapp.com/repos/flagarde/ProjectTemplate/branches/master/4?use_travis_com=true
[10]:❌
[0]: https://travis-ci.org/flagarde/ProjectTemplate