Ur-Codebin

Simple and easy to use code paste bin that allows easy code sharing!
View The Website »

Explore the docs · Report Bug · Request Feature

Table of Contents

• About the Project
  • Future Features
  • Technologies Used
• Getting Started
  • Prerequisites
  • Installation
  • Contributing
• Usage
• License
• Contact

About The Project

Ur-Codebin is a website aimed at creating an easy to use code sharing platform, that allows users to quickly and efficiently share their code with others. This project is inspired by many other similar websites.

Most of the focus was not on front-end design, but more on the back-end.The main purpose of this project was to help me learn more about back-end technologies,and the steps to creating a fully functioning production environment that uses many deployment technologies like Docker and AWS.

Technologies Used

• Vaadin
• Spring Boot
• Maven
• Docker
• Amazon Web Services
• MySQL Database

Getting Started

The following are steps for users who wish to get a local copy of the web application running on their machine, and contribute to the project.

Prerequisites

The following needs to be installed on your machine for the application to properly work.

• Maven
  • Download Tutorial

Cloning

1. Go to your preferred directory

cd FakeFolder/NotRealDirectory/

2. Clone the repo

git clone https://github.com/Mathew-Estafanous/Ur-Codebin.git

3. Run app using maven

mvn spring-boot:run

Contributing

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

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

Usage

The Ur-Codebin web application is very simple and easy to use. There are three main views that a user can interact with. First one is the main +Paste View in which the user can paste a snippet of their code and choose certain options pertaining to the paste. Once that is complete, the user can then click upload in which they will be re-routed to a page where they can view their paste. This view as an individual link that can be shared with any other person they wish to share it with.

The final view, is the public pastes page. Users can sift through publicly available pastes and look into each of the pastes and the information pertaining to them.

License

This project is Unlicensed and is free to be used! See LICENSE or http://unlicense.org for more detailed information.

Contact

Mathew Estafanous - mathewestafanous13@gmail.com

Project Link - https://github.com/Mathew-Estafanous/Ur-Codebin