TCM (Terms & Conditions Manager)

Manage your Terms & Conditions wisely and don't miss anything!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Description
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

TCM (Terms & Conditions Manager) is a chrome extension supports you manage Terms & Conditions effectively!

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

1. Chrome
2. Python && Flask
3. Node.js && npm

Installation

Run Locally

1. Clone the repo

   git clone https://github.com/junseo-yang/BellGeekfest2023.git

2. Change Directory to BellGeekfest2023

   cd BellGeekfest2023

3. Change Directory to backend

   cd backend

4. Change the openai.api_key in main.py with your OpenAI API key
5. Set up venv for python

   mkdir venv
   python3 -m venv ./venv
   source ./venv/bin/activate

6. Install python dependencies && Run Flask Server

   pip install -r requirements.txt
   python3 main.py # or python main.py

7. Open a new terminal
8. Change Directory to frontend

   cd ../chrome-extension

9. Install dependencies && Build frontend

   npm install
   npx vite build

10. Add chrome extension dist directory to your browser
    1. How to add your extension to the chrome browser
11. Done! You are all set!

(back to top)

Roadmap

• Implement Core Features
• Plan Future Improvement

See the open issues for a full list of proposed features (and known issues).

(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. See LICENSE.txt for more information.

(back to top)

Contact

Junseo Yang

• 💼 LinkedIn: https://linkedin.com/in/junseo-yang
• 🎒 Website: https://junseo-yang.github.io
• 📫 [email protected]

Branden Min

• 💼 LinkedIn: https://www.linkedin.com/in/brandenmin/
• 📫 [email protected]

Jaewon Yang

• 💼 LinkedIn: https://www.linkedin.com/in/jaewon-yang/
• 🎒 Website: https://j1yang.github.io/portfolio
• 📫 [email protected]

Jisang Kim

• 💼 LinkedIn: https://linkedin.com/in/jisang-kim/
• 📫 [email protected]

Project Link: https://github.com/junseo-yang/BellGeekfest2023

(back to top)