Skip to content

Latest commit

 

History

History
63 lines (36 loc) · 2.34 KB

README.md

File metadata and controls

63 lines (36 loc) · 2.34 KB
Raw

CodeClip

This repository contains the code for a web application that allows users to save, share and access their clipboard across any device connected to internet.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need to have Python3 and pip package manager installed on your machine. You can download them from the official website:

You will also need to have Flask and flask_sqlalchemy package installed in order to run this application.

Installing

  1. Clone the repository to your local machine

git clone https://github.com/anxkhn/codeclip.git

  1. Navigate to the project directory

cd codeclip

  1. Install the necessary packages

pip install -r requirements.txt

  1. Start the application

flask run

The application will now be running on http://127.0.0.1:5000

Deployment

This app is intended to be deployed in a web server, you can use PythonAnywhere to deploy this application.

Built With

  • CS50 - Harvard CS50's library for Python
  • Flask - A microframework for Python web applications
  • Flask-SQLAlchemy - An extension for Flask that adds support for SQLAlchemy
  • Flask QRcode - A Flask extension to render QR codes on Jinja2 templates
  • Werkzeug - A Flask framework that implements WSGI for handling requests.
  • Jinja2 - A templating language for Python, used by Flask.
  • PrismJS - Lightweight, robust, elegant syntax highlighting javascript library
  • Bootstrap 5 - An open source design system for HTML, CSS, and JS.

Contributing

To contribute to the project, please follow the CONTRIBUTING guidelines.

Author

License

This project is licensed under the MIT License - see the LICENSE file for details.