Table of Contents

1. About The Project
   • Built With
2. Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

This app should save you from the angry twitter users for saying something controversial but dont rely on it. Its still a work in progress. If you have any ideas that might contribute to it feel free to make it better.

So how does it work?

-It basically checks if you have said offensive words in your twitter from a big list with non pc words (the list is located in server/utils/profanity.js).

(back to top)

Built With

• React.js
• Express.js

(back to top)

Getting Started

If you want to run it locally this is how you do it:

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get your bearer token from https://developer.twitter.com/en/docs

2. Make a MongoDB Atlas account and find your connection string

3. Clone the repo

   git clone https://github.com/ivaylonikolov7/can-i-get-cancelled.git

4. Install NPM packages

   cd frontend
   npm install
   cd ../server
   npm install

5. Create a server_secrets.js file with the following structure:

   module.exports = {
        MONGODB_CONNECTION_STRING: 'YOUR MONGODB CONNECTION STRING',
        BEARER_TOKEN: 'YOUR TWITTER API BEARER TOKEN'
    }

6. Start backend side of the project

   cd server
   yarn start

7. You should start the frontend

   cd frontend
   yarn start

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Ivaylo Nikolov - @IvayloWasTaken - [email protected]

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Choose an Open Source License
• GitHub Emoji Cheat Sheet

(back to top)